org.osid.tracking.batch

Interface TrackingBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, Sourceable, TrackingBatchProfile

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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.tracking.batch.TrackingBatchProfile

supportsFrontOfficeBatchAdmin, supportsIssueBatchAdmin, supportsQueueBatchAdmin, supportsSubtaskIssueBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getIssueBatchAdminSession

IssueBatchAdminSession getIssueBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk issue administration service.

Returns:

a IssueBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsIssueBatchAdmin() is true.

getIssueBatchAdminSessionForFrontOffice

IssueBatchAdminSession getIssueBatchAdminSessionForFrontOffice(Id frontOfficeId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the bulk issue administration service for the given front office.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

a IssueBatchAdminSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsIssueBatchAdmin() and supportsVisibleFederation() are true

getSubtaskIssueBatchAdminSession

SubtaskIssueBatchAdminSession getSubtaskIssueBatchAdminSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk subtask administration service.

Returns:

a SubtaskBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubtaskBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsSubtaskBatchAdmin() is true.

getSubtaskIssueBatchAdminSessionForFrontOffice

SubtaskIssueBatchAdminSession getSubtaskIssueBatchAdminSessionForFrontOffice(Id frontOfficeId)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

Gets the OsidSession associated with the bulk subtask administration service for the given front office.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

a SubtaskBatchAdminSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubtaskBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSubtaskBatchAdmin() and supportsVisibleFederation() are true

getQueueBatchAdminSession

QueueBatchAdminSession getQueueBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk queue administration service.

Returns:

a QueueBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsQueueBatchAdmin() is true.

getQueueBatchAdminSessionForFrontOffice

QueueBatchAdminSession getQueueBatchAdminSessionForFrontOffice(Id frontOfficeId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the bulk queue administration service for the given front office.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

a QueueBatchAdminSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsQueueBatchAdmin() and supportsVisibleFederation() are true

getFrontOfficeBatchAdminSession

FrontOfficeBatchAdminSession getFrontOfficeBatchAdminSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with the bulk front office administration service.

Returns:

a FrontOfficeBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFrontOfficeBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsFrontOfficeBatchAdmin() is true.