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