public interface JobProcessorEnablerFoundryAssignmentSession extends OsidSession
This session provides methods to re-assign JobProcessorEnabler
to Foundry
mappings. A JobProcessorEnabler
may appear in multiple Foundry
objects and removing
the last reference to a JobProcessorEnabler
is the
equivalent of deleting it. Each Foundry
may have its own
authorizations governing who is allowed to operate on it.
Adding a reference of a JobProcessorEnabler
to another
Foundry
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignJobProcessorEnablerToFoundry(Id jobProcessorEnablerId,
Id foundryId)
Adds an existing
JobProcessorEnabler to a
Foundry. |
boolean |
canAssignJobProcessorEnablers()
Tests if this user can alter job processor enabler/foundry mappings.
|
boolean |
canAssignJobProcessorEnablersToFoundry(Id foundryId)
Tests if this user can alter job processor enabler/foundry mappings.
|
IdList |
getAssignableFoundryIds(Id foundryId)
Gets a list of foundries including and under the given foundry node in
which any job processor enabler can be assigned.
|
IdList |
getAssignableFoundryIdsForJobProcessorEnabler(Id foundryId,
Id jobProcessorEnablerId)
Gets a list of foundries including and under the given foundry node in
which a specific job processor enabler can be assigned.
|
void |
unassignJobProcessorEnablerFromFoundry(Id jobProcessorEnablerId,
Id foundryId)
Removes a
JobProcessorEnabler from a Foundry. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignJobProcessorEnablers()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignJobProcessorEnablersToFoundry(Id foundryId)
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users.foundryId
- the Id
of the Foundry
false
if mapping is not authorized, true
otherwiseNullArgumentException
- foundryId
is
null
mandatory
- This method must be implemented. IdList getAssignableFoundryIds(Id foundryId) throws OperationFailedException
foundryId
- the Id
of the Foundry
Ids
NullArgumentException
- foundryId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableFoundryIdsForJobProcessorEnabler(Id foundryId, Id jobProcessorEnablerId) throws OperationFailedException
foundryId
- the Id
of the Foundry
jobProcessorEnablerId
- the Id
of the
JobProcessorEnabler
Ids
NullArgumentException
- foundryId
or
jobProcessorEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignJobProcessorEnablerToFoundry(Id jobProcessorEnablerId, Id foundryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessorEnabler
to a
Foundry.
jobProcessorEnablerId
- the Id
of the
JobProcessorEnabler
foundryId
- the Id
of the Foundry
AlreadyExistsException
- jobProcessorEnablerId
is already assigned to foundryId
NotFoundException
- jobProcessorEnablerId
or foundryId
not foundNullArgumentException
- jobProcessorEnablerId
or foundryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignJobProcessorEnablerFromFoundry(Id jobProcessorEnablerId, Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessorEnabler
from a Foundry.
jobProcessorEnablerId
- the Id
of the
JobProcessorEnabler
foundryId
- the Id
of the Foundry
NotFoundException
- jobProcessorEnablerId
or foundryId
not found or
jobProcessorEnablerId
not assigned to foundryId
NullArgumentException
- jobProcessorEnablerId
or foundryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.