public interface WorkFoundryAssignmentSession extends OsidSession
This session provides methods to re-assign Works
to
Foundry
mappings. A Work
may appear in
multiple Foundry
objects and removing the last reference to
a Work
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 Work
to another Foundry
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignWorkToFoundry(Id workId,
Id foundryId)
Adds an existing
Work to a Foundry. |
boolean |
canAssignWorks()
Tests if this user can alter work/foundry mappings.
|
boolean |
canAssignWorksToFoundry(Id foundryId)
Tests if this user can alter work/foundry mappings.
|
IdList |
getAssignableFoundryIds(Id foundryId)
Gets a list of foundries including and under the given foundry node in
which any work can be assigned.
|
IdList |
getAssignableFoundryIdsForWork(Id foundryId,
Id workId)
Gets a list of foundries including and under the given foundry node in
which a specific work can be assigned.
|
void |
unassignWorkFromFoundry(Id workId,
Id foundryId)
Removes a
Work from a Foundry. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignWorks()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignWorksToFoundry(Id foundryId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.foundryId
- the Id
of the Foundry
false
if resourcing 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 getAssignableFoundryIdsForWork(Id foundryId, Id workId) throws OperationFailedException
foundryId
- the Id
of the Foundry
workId
- the Id
of the Work
Ids
NullArgumentException
- foundryId
or
workId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignWorkToFoundry(Id workId, Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Work
to a Foundry.
workId
- the Id
of the Work
foundryId
- the Id
of the Foundry
NotFoundException
- workId
or
foundryId
not foundNullArgumentException
- workId
or
foundryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignWorkFromFoundry(Id workId, Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Work
from a Foundry.
workId
- the Id
of the Work
foundryId
- the Id
of the Foundry
NotFoundException
- workId
or
foundryId
not foundNullArgumentException
- workId
or
foundryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.