Interface TrackingBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable, TrackingBatchProfile

public interface TrackingBatchProxyManager
extends OsidProxyManager, TrackingBatchProfile

The tracking batch proxy manager provides access to tracking batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• IssueBatchAdminSession : a session to manage issues in bulk
• SubtaskBatchAdminSession : a session to manage subtasks in bulk
• QueueBatchAdminSession : a session to manage queued in bulk
• FrontOfficeBatchAdminSession : a session to create, modify and delete FrontOffice in bulk

Method Summary

Modifier and Type	Method	Description
FrontOfficeBatchAdminSession	getFrontOfficeBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk front office administration service.
IssueBatchAdminSession	getIssueBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk issue administration service.
IssueBatchAdminSession	getIssueBatchAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy)	Gets the OsidSession associated with the bulk issue administration service for the given front office.
QueueBatchAdminSession	getQueueBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk queue administration service.
QueueBatchAdminSession	getQueueBatchAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy)	Gets the OsidSession associated with the bulk queue administration service for the given front office.
SubtaskIssueBatchAdminSession	getSubtaskIssueBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk subtask issue administration service.
SubtaskIssueBatchAdminSession	getSubtaskIssueBatchAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy)	Gets the OsidSession associated with the bulk subtask issue administration service for the given front office.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Methods inherited from interface TrackingBatchProfile

supportsFrontOfficeBatchAdmin, supportsIssueBatchAdmin, supportsQueueBatchAdmin, supportsSubtaskIssueBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsFrontOfficeBatchAdmin()	Tests if bulk administration of front offices is available.
boolean	supportsIssueBatchAdmin()	Tests if bulk administration of issues is available.
boolean	supportsQueueBatchAdmin()	Tests if bulk administration of queues is available.
boolean	supportsSubtaskIssueBatchAdmin()	Tests if bulk administration of subtasks is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Method Details

getIssueBatchAdminSession

IssueBatchAdminSession getIssueBatchAdminSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk issue administration service.

Parameters:

proxy - a proxy

Returns:

a IssueBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsIssueBatchAdmin()} is {@code true} .

getIssueBatchAdminSessionForFrontOffice

IssueBatchAdminSession getIssueBatchAdminSessionForFrontOffice(Id frontOfficeId,
 Proxy proxy)
                                                        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

proxy - a proxy

Returns:

a IssueBatchAdminSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsIssueBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getSubtaskIssueBatchAdminSession

SubtaskIssueBatchAdminSession getSubtaskIssueBatchAdminSession(Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession associated with the bulk subtask issue administration service.

Parameters:

proxy - a proxy

Returns:

a SubtaskIssueBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubtaskIssueBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsSubtaskIssueBatchAdmin()} is {@code true} .

getSubtaskIssueBatchAdminSessionForFrontOffice

SubtaskIssueBatchAdminSession getSubtaskIssueBatchAdminSessionForFrontOffice(Id frontOfficeId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

frontOfficeId - the Id of the FrontOffice

proxy - a proxy

Returns:

a SubtaskIssueBatchAdminSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubtaskIssueBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubtaskIssueBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getQueueBatchAdminSession

QueueBatchAdminSession getQueueBatchAdminSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk queue administration service.

Parameters:

proxy - a proxy

Returns:

a QueueBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueBatchAdmin()} is {@code true} .

getQueueBatchAdminSessionForFrontOffice

QueueBatchAdminSession getQueueBatchAdminSessionForFrontOffice(Id frontOfficeId,
 Proxy proxy)
                                                        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

proxy - a proxy

Returns:

a QueueBatchAdminSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getFrontOfficeBatchAdminSession

FrontOfficeBatchAdminSession getFrontOfficeBatchAdminSession(Proxy proxy)
                                                      throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a FrontOfficeBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFrontOfficeBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsFrontOfficeBatchAdmin()} is {@code true} .