public interface TrackingBatchManager extends OsidManager, TrackingBatchProfile
The tracking batch manager provides access to tracking batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
IssueBatchAdminSession:
a session to create,
modify and delete Issues
in bulk SubtaskBatchAdminSession:
a session to create,
modify and delete Subtasks in bulk QueueBatchAdminSession:
a session to create,
modify and delete Queues in bulk FrontOfficeBatchAdminSession:
a session to create,
modify and delete FrontOffice
in bulk Modifier and Type | Method and Description |
---|---|
FrontOfficeBatchAdminSession |
getFrontOfficeBatchAdminSession()
Gets the
OsidSession associated with the bulk front
office administration service. |
IssueBatchAdminSession |
getIssueBatchAdminSession()
Gets the
OsidSession associated with the bulk issue
administration service. |
IssueBatchAdminSession |
getIssueBatchAdminSessionForFrontOffice(Id frontOfficeId)
Gets the
OsidSession associated with the bulk issue
administration service for the given front office. |
QueueBatchAdminSession |
getQueueBatchAdminSession()
Gets the
OsidSession associated with the bulk queue
administration service. |
QueueBatchAdminSession |
getQueueBatchAdminSessionForFrontOffice(Id frontOfficeId)
Gets the
OsidSession associated with the bulk queue
administration service for the given front office. |
SubtaskIssueBatchAdminSession |
getSubtaskIssueBatchAdminSession()
Gets the
OsidSession associated with the bulk subtask
administration service. |
SubtaskIssueBatchAdminSession |
getSubtaskIssueBatchAdminSessionForFrontOffice(Id frontOfficeId)
Gets the
OsidSession associated with the bulk subtask
administration service for the given front office. |
changeBranch, initialize, rollbackService
close
supportsFrontOfficeBatchAdmin, supportsIssueBatchAdmin, supportsQueueBatchAdmin, supportsSubtaskIssueBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
IssueBatchAdminSession getIssueBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk issue
administration service. IssueBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIssueBatchAdmin()
is false
optional
- This method must be implemented if
supportsIssueBatchAdmin()
is true.
IssueBatchAdminSession getIssueBatchAdminSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk issue
administration service for the given front office.frontOfficeId
- the Id
of the FrontOffice
IssueBatchAdminSession
NotFoundException
- no FrontOffice
found
by the given Id
NullArgumentException
- frontOfficeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIssueBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsIssueBatchAdmin()
and
supportsVisibleFederation()
are true
SubtaskIssueBatchAdminSession getSubtaskIssueBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk subtask
administration service. SubtaskBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubtaskBatchAdmin()
is false
optional
- This method must be implemented if
supportsSubtaskBatchAdmin()
is true.
SubtaskIssueBatchAdminSession getSubtaskIssueBatchAdminSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk subtask
administration service for the given front office.frontOfficeId
- the Id
of the FrontOffice
SubtaskBatchAdminSession
NotFoundException
- no FrontOffice
found
by the given Id
NullArgumentException
- frontOfficeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSubtaskBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSubtaskBatchAdmin()
and
supportsVisibleFederation()
are true
QueueBatchAdminSession getQueueBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk queue
administration service. QueueBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQueueBatchAdmin()
is false
optional
- This method must be implemented if
supportsQueueBatchAdmin()
is true.
QueueBatchAdminSession getQueueBatchAdminSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk queue
administration service for the given front office.frontOfficeId
- the Id
of the FrontOffice
QueueBatchAdminSession
NotFoundException
- no FrontOffice
found
by the given Id
NullArgumentException
- frontOfficeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQueueBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsQueueBatchAdmin()
and
supportsVisibleFederation()
are true
FrontOfficeBatchAdminSession getFrontOfficeBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk front
office administration service. FrontOfficeBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFrontOfficeBatchAdmin()
is false
optional
- This method must be implemented if
supportsFrontOfficeBatchAdmin()
is true.