public interface JobProcessorAdminSession extends OsidSession
This session creates and removes job processors. The data for create
and update is provided via the JobProcessorForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasJobProcessor(Id jobProcessorId,
Id aliasId)
Adds an
Id to a JobProcessor for the
purpose of creating compatibility. |
boolean |
canCreateJobProcessor()
Tests if this user can create job processors.
|
boolean |
canCreateJobProcessorWithRecordTypes(Type[] jobProcessorRecordTypes)
Tests if this user can create a single
JobProcessor
using the desired record types. |
boolean |
canDeleteJobProcessors()
Tests if this user can delete job processors.
|
boolean |
canManageJobProcessorAliases()
Tests if this user can manage
Id aliases for job
processors. |
boolean |
canUpdateJobProcessors()
Tests if this user can update job processors.
|
JobProcessor |
createJobProcessor(JobProcessorForm jobProcessorForm)
Creates a new
JobProcessor. |
void |
deleteJobProcessor(Id jobProcessorId)
Deletes a
JobProcessor. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
JobProcessorForm |
getJobProcessorFormForCreate(Type[] jobProcessorRecordTypes)
Gets the job processor form for creating new job processors.
|
JobProcessorForm |
getJobProcessorFormForUpdate(Id jobProcessorId)
Gets the job processor form for updating an existing job processor.
|
void |
updateJobProcessor(JobProcessorForm jobProcessorForm)
Updates an existing job processor.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateJobProcessor()
JobProcessor
will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer create operations to an
unauthorized user. false
if JobProcessor
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateJobProcessorWithRecordTypes(Type[] jobProcessorRecordTypes)
JobProcessor
using the desired record types. While
ResourcingRulesManager.getJobProcessorRecordTypes()
can be
used to examine which records are supported, this method tests which
record(s) are required for creating a specific JobProcessor.
Providing an empty array tests if a JobProcessor
can be created with no records.jobProcessorRecordTypes
- array of job processor record types true
if JobProcessor
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
- jobProcessorRecordTypes
is null
mandatory
- This method must be implemented. JobProcessorForm getJobProcessorFormForCreate(Type[] jobProcessorRecordTypes) throws OperationFailedException, PermissionDeniedException
jobProcessorRecordTypes
- array of job processor record typesNullArgumentException
- jobProcessorRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form with
requested record typesmandatory
- This method must be implemented. JobProcessor createJobProcessor(JobProcessorForm jobProcessorForm) throws OperationFailedException, PermissionDeniedException
JobProcessor.
jobProcessorForm
- the form for this JobProcessor
JobProcessor
IllegalStateException
- jobProcessorForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- jobProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- jobProcessorForm
did not originate from getJobProcessorFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateJobProcessors()
JobProcessor
will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer update operations to an
unauthorized user. false
if JobProcessor
modification is not authorized, true
otherwisemandatory
- This method must be implemented. JobProcessorForm getJobProcessorFormForUpdate(Id jobProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
jobProcessorId
- the Id
of the
JobProcessor
NotFoundException
- jobProcessorId
is
not foundNullArgumentException
- jobProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateJobProcessor(JobProcessorForm jobProcessorForm) throws OperationFailedException, PermissionDeniedException
jobProcessorForm
- the form containing the elements to be
updatedIllegalStateException
- jobProcessorForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- jobProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- jobProcessorForm
did not originate from getJobProcessorFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteJobProcessors()
JobProcessor
will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer delete operations to an
unauthorized user. false
if JobProcessor
deletion
is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteJobProcessor(Id jobProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessor.
jobProcessorId
- the Id
of the
JobProcessor
to removeNotFoundException
- jobProcessorId
not
foundNullArgumentException
- jobProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageJobProcessorAliases()
Id
aliases for job
processors. A return of true does not guarantee successful
authorization. A return of false indicates that it is known changing
an alias will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer alias
operations to an unauthorized user. false
if JobProcessor
aliasing
is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasJobProcessor(Id jobProcessorId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a JobProcessor
for the
purpose of creating compatibility. The primary Id
of
the JobProcessor
is determined by the provider. The new
Id
performs as an alias to the primary Id
. If the alias is a pointer to another job processor. it is
reassigned to the given job processor Id.
jobProcessorId
- the Id
of a JobProcessor
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- jobProcessorId
not
foundNullArgumentException
- jobProcessorId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.