Interface Broker

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject

public interface Broker
extends OsidGovernator

A Broker manages queues and pools.

Method Summary

Modifier and Type	Method	Description
IdList	getBrokerageIds()	Gets the Ids of the brokerages.
ResourceList	getBrokerages()	Gets the brokerages.
BrokerRecord	getBrokerRecord(Type brokerRecordType)	Gets the broker record corresponding to the given Broker record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface Operable

isActive, isDisabled, isEnabled, isOperational

Modifier and Type	Method	Description
boolean	isActive()	Tests if this operable is active.
boolean	isDisabled()	Tests if this operable is administravely disabled.
boolean	isEnabled()	Tests if this operable is administravely enabled.
boolean	isOperational()	Tests if this Operable is operational.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Method Details

getBrokerageIds

IdList getBrokerageIds()

Gets the Ids of the brokerages.

Returns:

the brokerage Ids

Compliance:

mandatory - This method must be implemented.

getBrokerages

ResourceList getBrokerages()
                    throws OperationFailedException

Gets the brokerages.

Returns:

the brokerages

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getBrokerRecord

BrokerRecord getBrokerRecord(Type brokerRecordType)
                      throws OperationFailedException

Gets the broker record corresponding to the given Broker record Type .This method is used to retrieve an object implementing the requested record. The brokerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(brokerRecordType) is true .

Parameters:

brokerRecordType - the type of broker record to retrieve

Returns:

the broker record

Throws:

NullArgumentException - brokerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerRecordType) is false

Compliance:

mandatory - This method must be implemented.