public interface OffsetEventEnablerAdminSession extends OsidSession
This session creates and removes offset event enablers. The data for
create and update is provided via the OffsetEventEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasOffsetEventEnabler(Id offsetEventEnablerId,
Id aliasId)
Adds an
Id to an OffsetEventEnabler for
the purpose of creating compatibility. |
boolean |
canCreateOffsetEventEnabler()
Tests if this user can create offset event enablers.
|
boolean |
canCreateOffsetEventEnablerWithRecordTypes(Type[] offsetEventEnablerRecordTypes)
Tests if this user can create a single
OffsetEventEnabler
using the desired record types. |
boolean |
canDeleteOffsetEventEnablers()
Tests if this user can delete offset event enablers.
|
boolean |
canManageOffsetEventEnablerAliases()
Tests if this user can manage
Id aliases for offset
event enablers. |
boolean |
canUpdateOffsetEventEnablers()
Tests if this user can update offset event enablers.
|
OffsetEventEnabler |
createOffsetEventEnabler(OffsetEventEnablerForm offsetEventEnablerForm)
Creates a new
OffsetEventEnabler. |
void |
deleteOffsetEventEnabler(Id offsetEventEnablerId)
Deletes an
OffsetEventEnabler. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
OffsetEventEnablerForm |
getOffsetEventEnablerFormForCreate(Type[] offsetEventEnablerRecordTypes)
Gets the offset event enabler form for creating new offset event
enablers.
|
OffsetEventEnablerForm |
getOffsetEventEnablerFormForUpdate(Id offsetEventEnablerId)
Gets the offset event enabler form for updating an existing offset
event enabler.
|
void |
updateOffsetEventEnabler(OffsetEventEnablerForm offsetEventEnablerForm)
Updates an existing offset event enabler.
|
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.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateOffsetEventEnabler()
OffsetEventEnabler
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 OffsetEventEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateOffsetEventEnablerWithRecordTypes(Type[] offsetEventEnablerRecordTypes)
OffsetEventEnabler
using the desired record types. While
CalendarRulesManager.getOffsetEventEnablerRecordTypes()
can be
used to examine which records are supported, this method tests which
record(s) are required for creating a specific
OffsetEventEnabler.
Providing an empty array tests if an
OffsetEventEnabler
can be created with no records.offsetEventEnablerRecordTypes
- array of offset event enabler
record types true
if OffsetEventEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
offsetEventEnablerRecordTypes
is null
mandatory
- This method must be implemented. OffsetEventEnablerForm getOffsetEventEnablerFormForCreate(Type[] offsetEventEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
offsetEventEnablerRecordTypes
- array of offset event enabler
record typesNullArgumentException
-
offsetEventEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. OffsetEventEnabler createOffsetEventEnabler(OffsetEventEnablerForm offsetEventEnablerForm) throws OperationFailedException, PermissionDeniedException
OffsetEventEnabler.
offsetEventEnablerForm
- the form for this
OffsetEventEnabler
OffsetEventEnabler
IllegalStateException
- offsetEventEnablerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- offsetEventEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- offsetEventEnablerForm
did not originate from
getOffsetEventEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateOffsetEventEnablers()
OffsetEventEnabler
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 OffsetEventEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. OffsetEventEnablerForm getOffsetEventEnablerFormForUpdate(Id offsetEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
offsetEventEnablerId
- the Id
of the
OffsetEventEnabler
NotFoundException
- offsetEventEnablerId
is not foundNullArgumentException
- offsetEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateOffsetEventEnabler(OffsetEventEnablerForm offsetEventEnablerForm) throws OperationFailedException, PermissionDeniedException
offsetEventEnablerForm
- the form containing the elements to be
updatedIllegalStateException
- offsetEventEnablerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- offsetEventEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- offsetEventEnablerForm
did not originate from
getOffsetEventEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteOffsetEventEnablers()
OffsetEventEnabler
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 OffsetEventEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteOffsetEventEnabler(Id offsetEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OffsetEventEnabler.
offsetEventEnablerId
- the Id
of the
OffsetEventEnabler
to removeNotFoundException
- offsetEventEnablerId
not foundNullArgumentException
- offsetEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageOffsetEventEnablerAliases()
Id
aliases for offset
event enablers. 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 OffsetEventEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasOffsetEventEnabler(Id offsetEventEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to an OffsetEventEnabler
for
the purpose of creating compatibility. The primary Id
of the OffsetEventEnabler
is determined by the
provider. The new Id
performs as an alias to the
primary Id
. If the alias is a pointer to another
offset event enabler. it is reassigned to the given offset event
enabler Id.
offsetEventEnablerId
- the Id
of an
OffsetEventEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- offsetEventEnablerId
not foundNullArgumentException
- offsetEventEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.