public interface TimePeriodCyclicTimePeriodAssignmentSession extends OsidSession
This session provides methods to manually assign TimePeriods
to CyclicTimePeriods.
Modifier and Type | Method and Description |
---|---|
void |
assignTimePeriodToCyclicTimePeriod(Id timePeriodId,
Id cyclicTimePeriodId)
Adds an existing
TimePeriod to a
CyclicTimePeriod. |
boolean |
canAssignCyclicTimePeriodsToCyclicTimePeriod(Id cyclicTimePeriodId)
Tests if this user can alter time period/cyclic time period mappings.
|
boolean |
canAssignTimePeriods()
Tests if this user can alter time period/cyclic time period mappings.
|
IdList |
getAssignableCyclicTimePeriodIds()
Gets a list of cyclic time period
Ids. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
void |
unassignTimePeriodFromCyclicTimePeriod(Id timePeriodId,
Id cyclicTimePeriodId)
Removes a
TimePeriod from a CyclicTimePeriod. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCalendarId()
Calendar
Id
associated with
this session. Calendar Id
associated with this sessionmandatory
- This method must be implemented. Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
Calendar
associated with this session. Calendar
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignTimePeriods()
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 canAssignCyclicTimePeriodsToCyclicTimePeriod(Id cyclicTimePeriodId)
cyclicTimePeriodId
- the Id
of the
CyclicTimePeriod
false
if mapping is not authorized, true
otherwiseNullArgumentException
- cyclicTimePeriodId
is null
mandatory
- This method must be implemented. IdList getAssignableCyclicTimePeriodIds() throws OperationFailedException
Ids.
Ids
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignTimePeriodToCyclicTimePeriod(Id timePeriodId, Id cyclicTimePeriodId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
TimePeriod
to a
CyclicTimePeriod.
timePeriodId
- the Id
of the TimePeriod
cyclicTimePeriodId
- the Id
of the
CyclicTimePeriod
AlreadyExistsException
- timePeriodId
is
alrteady assigned to cyclicTimePeriodId
NotFoundException
- timePeriodId
or
cyclicTimePeriodId
not foundNullArgumentException
- timePeriodId
or
cyclicTimePeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignTimePeriodFromCyclicTimePeriod(Id timePeriodId, Id cyclicTimePeriodId) throws NotFoundException, OperationFailedException, PermissionDeniedException
TimePeriod
from a CyclicTimePeriod.
timePeriodId
- the Id
of the TimePeriod
cyclicTimePeriodId
- the Id
of the
CyclicTimePeriod
NotFoundException
- timePeriodId
or
cyclicTimePeriodId
not found or
timePeriodId
is not asigned to
cyclicTimePeriodId
NullArgumentException
- timePeriodId
or
cyclicTimePeriodId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.