Interface ResourceProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, ResourceProfile, Sourceable

public interface ResourceProxyManager
extends OsidProxyManager, ResourceProfile

The resource manager provides access to resource lookup and creation session and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy .The sessions included in this manager are:

• ResourceLookupSession : a session to retrieve resources
• ResourceQuerySession : a session to query resources
• ResourceSearchSession : a session to search for resources
• ResourceAdminSession : a session to create and delete resources
• ResourceNotificationSession : a session to receive notifications pertaining to resource changes
• ResourceBinSession : a session to look up resource to bin mappings
• ResourceBinAssignmentSession : a session to manage resource to bin mappings
• ResourceSmartBinSession : a session to manage smart resource bins
• MembershipSession : a session to query memberships
• GroupSession : a session to retrieve group memberships
• GroupAssignmentSession : a session to manage groups
• GroupNotificationSession : a session to retrieve notifications on changes to group membership
• GroupHierarchySession : a session to view a group hierarchy
• RsourceAgentSession : a session to retrieve Resource and Agent mappings
• ResourceAgentAssignmentSession : a session to manage Resource and Agent mappings

• ResourceRelationshipLookupSession : a session to retrieve resource relationships
• ResourceRelationshipQuerySession : a session to query for resource relationships
• ResourceRelationshipSearchSession : a session to search for resource relationships
• ResourceRelationshipAdminSession : a session to create and delete resource relationships
• ResourceRelationshipNotificationSession : a session to receive notifications pertaining to resource relationshipchanges
• ResourceRelationshipBinSession : a session to look up resource relationship to bin mappings
• ResourceRelationshipBinAssignmentSession : a session to manage resource relationship to bin mappings
• ResourceRelationshipSmartBinSession : a session to manage smart resource relationship bins

• BinLookupSession: a session to retrieve bins
• BinQuerySession : a session to query bins
• BinSearchSession : a session to search for bins
• BinAdminSession : a session to create, update and delete bins
• BinNotificationSession : a session to receive notifications pertaining to changes in bins
• BinHierarchySession : a session to traverse bin hierarchies
• BinHierarchyDesignSession : a session to manage bin hierarchies

Method Summary

Modifier and Type	Method	Description
BinAdminSession	getBinAdminSession(Proxy proxy)	Gets the bin administrative session for creating, updating and deleteing bins.
BinHierarchyDesignSession	getBinHierarchyDesignSession(Proxy proxy)	Gets the bin hierarchy design session.
BinHierarchySession	getBinHierarchySession(Proxy proxy)	Gets the bin hierarchy traversal session.
BinLookupSession	getBinLookupSession(Proxy proxy)	Gets the bin lookup session.
BinNotificationSession	getBinNotificationSession(BinReceiver binReceiver, Proxy proxy)	Gets the notification session for subscribing to changes to a bin.
BinQuerySession	getBinQuerySession(Proxy proxy)	Gets the bin query session.
BinSearchSession	getBinSearchSession(Proxy proxy)	Gets the bin search session.
GroupAssignmentSession	getGroupAssignmentSession(Proxy proxy)	Gets the session for assigning resources to groups.
GroupAssignmentSession	getGroupAssignmentSessionForBin(Id binId, Proxy proxy)	Gets a group assignment session for the given bin.
BinHierarchySession	getGroupHierarchySession(Proxy proxy)	Gets the group hierarchy traversal session for the given resource group.
GroupHierarchySession	getGroupHierarchySessionForBin(Id binId, Proxy proxy)	Gets a group hierarchy session for the given bin.
GroupNotificationSession	getGroupNotificationSession(GroupReceiver groupRceeiver, Proxy proxy)	Gets the notification session for notifications pertaining to resource changes.
GroupNotificationSession	getGroupNotificationSessionForBin(GroupReceiver groupRceeiver, Id binId, Proxy proxy)	Gets the group notification session for the given bin.
GroupSession	getGroupSession(Proxy proxy)	Gets the session for retrieving gropup memberships.
GroupSession	getGroupSessionForBin(Id binId, Proxy proxy)	Gets a group session for the given bin.
MembershipSession	getMembershipSession(Proxy proxy)	Gets the session for querying memberships.
MembershipSession	getMembershipSessionForBin(Id binId, Proxy proxy)	Gets a resource membership session for the given bin.
ResourceAdminSession	getResourceAdminSession(Proxy proxy)	Gets a resource administration session for creating, updating and deleting resources.
ResourceAdminSession	getResourceAdminSessionForBin(Id binId, Proxy proxy)	Gets a resource administration session for the given bin.
ResourceAgentAssignmentSession	getResourceAgentAssignmentSession(Proxy proxy)	Gets the session for assigning agents to resources.
ResourceAgentAssignmentSession	getResourceAgentAssignmentSessionForBin(Id binId, Proxy proxy)	Gets a resource agent session for the given bin.
ResourceAgentSession	getResourceAgentSession(Proxy proxy)	Gets the session for retrieving resource agent mappings.
ResourceAgentSession	getResourceAgentSessionForBin(Id binId, Proxy proxy)	Gets a resource agent session for the given bin.
ResourceBatchProxyManager	getResourceBatchProxyManager()	Gets the ResourceBatchProxyManager .
ResourceBinAssignmentSession	getResourceBinAssignmentSession(Proxy proxy)	Gets the session for assigning resource to bin mappings.
ResourceBinSession	getResourceBinSession(Proxy proxy)	Gets the session for retrieving resource to bin mappings.
ResourceDemographicProxyManager	getResourceDemographicProxyManager()	Gets the ResourceDemographicProxyManager .
ResourceLookupSession	getResourceLookupSession(Proxy proxy)	Gets the OsidSession associated with the resource lookup service.
ResourceLookupSession	getResourceLookupSessionForBin(Id binId, Proxy proxy)	Gets the OsidSession associated with the resource lookup service for the given bin.
ResourceNotificationSession	getResourceNotificationSession(ResourceReceiver resourceReceiver, Proxy proxy)	Gets the resource notification session for the given bin.
ResourceNotificationSession	getResourceNotificationSessionForBin(ResourceReceiver resourceReceiver, Id binId, Proxy proxy)	Gets the resource notification session for the given bin.
ResourceQuerySession	getResourceQuerySession(Proxy proxy)	Gets a resource query session.
ResourceQuerySession	getResourceQuerySessionForBin(Id binId, Proxy proxy)	Gets a resource query session for the given bin.
ResourceRelationshipAdminSession	getResourceRelationshipAdminSession(Proxy proxy)	Gets the OsidSession associated with the resource relationship administration service.
ResourceRelationshipAdminSession	getResourceRelationshipAdminSessionForBin(Id binId, Proxy proxy)	Gets the OsidSession associated with the resource relationship administration service for the given bin.
ResourceRelationshipBinAssignmentSession	getResourceRelationshipBinAssignmentSession(Proxy proxy)	Gets the session for assigning resource relationship to bin mappings.
ResourceRelationshipBinSession	getResourceRelationshipBinSession(Proxy proxy)	Gets the session for retrieving resource relationship to bin mappings.
ResourceRelationshipLookupSession	getResourceRelationshipLookupSession(Proxy proxy)	Gets the OsidSession associated with the resource relationship lookup service.
ResourceRelationshipLookupSession	getResourceRelationshipLookupSessionForBin(Id binId, Proxy proxy)	Gets the OsidSession associated with the resource relationship lookup service for the given bin.
ResourceRelationshipNotificationSession	getResourceRelationshipNotificationSession(ResourceRelationshipReceiver resourceRelationshipReceiver, Proxy proxy)	Gets the OsidSession associated with the resource relationship notification service.
ResourceRelationshipNotificationSession	getResourceRelationshipNotificationSessionForBin(ResourceRelationshipReceiver resourceRelationshipReceiver, Id binId, Proxy proxy)	Gets the OsidSession associated with the resource relationship notification service for the given bin.
ResourceRelationshipQuerySession	getResourceRelationshipQuerySession(Proxy proxy)	Gets the OsidSession associated with the resource relationship query service.
ResourceRelationshipQuerySession	getResourceRelationshipQuerySessionForBin(Id binId, Proxy proxy)	Gets the OsidSession associated with the resource relationship query service for the given bin.
ResourceRelationshipSearchSession	getResourceRelationshipSearchSession(Proxy proxy)	Gets the OsidSession associated with the resource relationship search service.
ResourceRelationshipSearchSession	getResourceRelationshipSearchSessionForBin(Id binId, Proxy proxy)	Gets the OsidSession associated with the resource relationship search service for the given bin.
ResourceRelationshipSmartBinSession	getResourceRelationshipSmartBinSession(Id binId, Proxy proxy)	Gets the session for managing dynamic resource relationship bins.
ResourceSearchSession	getResourceSearchSession(Proxy proxy)	Gets a resource search session.
ResourceSearchSession	getResourceSearchSessionForBin(Id binId, Proxy proxy)	Gets a resource search session for the given bin.
ResourceSmartBinSession	getResourceSmartBinSession(Id binId, Proxy proxy)	Gets the session for managing dynamic resource bins.

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 ResourceProfile

getBinRecordTypes, getBinSearchRecordTypes, getResourceRecordTypes, getResourceRelationshipRecordTypes, getResourceRelationshipSearchRecordTypes, getResourceSearchRecordTypes, supportsBinAdmin, supportsBinHierarchy, supportsBinHierarchyDesign, supportsBinLookup, supportsBinNotification, supportsBinQuery, supportsBinRecordType, supportsBinSearch, supportsBinSearchRecordType, supportsGroup, supportsGroupAssignment, supportsGroupHierarchy, supportsGroupNotification, supportsMembership, supportsResourceAdmin, supportsResourceAgent, supportsResourceAgentAssignment, supportsResourceBatch, supportsResourceBin, supportsResourceBinAssignment, supportsResourceDemographic, supportsResourceLookup, supportsResourceNotification, supportsResourceQuery, supportsResourceRecordType, supportsResourceRelationshipAdmin, supportsResourceRelationshipBin, supportsResourceRelationshipBinAssignment, supportsResourceRelationshipLookup, supportsResourceRelationshipNotification, supportsResourceRelationshipQuery, supportsResourceRelationshipRecordType, supportsResourceRelationshipSearch, supportsResourceRelationshipSearchRecordType, supportsResourceRelationshipSmartBin, supportsResourceSearch, supportsResourceSearchRecordType, supportsResourceSmartBin, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getBinRecordTypes()	Gets all the bin record types supported.
TypeList	getBinSearchRecordTypes()	Gets all the bin search record types supported.
TypeList	getResourceRecordTypes()	Gets all the resource record types supported.
TypeList	getResourceRelationshipRecordTypes()	Gets the supported ResourceRelationship record types.
TypeList	getResourceRelationshipSearchRecordTypes()	Gets the supported ResourceRelationship search record types.
TypeList	getResourceSearchRecordTypes()	Gets all the resource search record types supported.
boolean	supportsBinAdmin()	Tests if bin administration is supported.
boolean	supportsBinHierarchy()	Tests if a bin hierarchy traversal is supported.
boolean	supportsBinHierarchyDesign()	Tests if a bin hierarchy design is supported.
boolean	supportsBinLookup()	Tests if bin lookup is supported.
boolean	supportsBinNotification()	Tests if bin notification is supported.
boolean	supportsBinQuery()	Tests if bin query is supported.
boolean	supportsBinRecordType(Type binRecordType)	Tests if a given bin record type is supported.
boolean	supportsBinSearch()	Tests if bin search is supported.
boolean	supportsBinSearchRecordType(Type binSearchRecordType)	Tests if a given bin search record type is supported.
boolean	supportsGroup()	Tests if group resources are supported.
boolean	supportsGroupAssignment()	Tests if group resource assignment is supported.
boolean	supportsGroupHierarchy()	Tests if a group resource hierarchy service is supported.
boolean	supportsGroupNotification()	Tests if group resource notification is supported.
boolean	supportsMembership()	Tests if membership queries are supported.
boolean	supportsResourceAdmin()	Tests if resource administration is supported.
boolean	supportsResourceAgent()	Tests if retrieving mappings of resource and agents is supported.
boolean	supportsResourceAgentAssignment()	Tests if managing mappings of resources and agents is supported.
boolean	supportsResourceBatch()	Tests if a resource batch service is available.
boolean	supportsResourceBin()	Tests if retrieving mappings of resource and bins is supported.
boolean	supportsResourceBinAssignment()	Tests if managing mappings of resource and bins is supported.
boolean	supportsResourceDemographic()	Tests if a resource demographic service is available.
boolean	supportsResourceLookup()	Tests if resource lookup is supported.
boolean	supportsResourceNotification()	Tests if resource notification is supported.
boolean	supportsResourceQuery()	Tests if resource query is supported.
boolean	supportsResourceRecordType(Type resourceRecordType)	Tests if a given resource record type is supported.
boolean	supportsResourceRelationshipAdmin()	Tests if a resource relationships administrative service is supported.
boolean	supportsResourceRelationshipBin()	Tests if retrieving mappings of resource relationships and bins is supported.
boolean	supportsResourceRelationshipBinAssignment()	Tests if managing mappings of resource relationships and bins is supported.
boolean	supportsResourceRelationshipLookup()	Tests if looking up resource relationships is supported.
boolean	supportsResourceRelationshipNotification()	Tests if a resource relationships notification service is supported.
boolean	supportsResourceRelationshipQuery()	Tests if querying resource relationships is supported.
boolean	supportsResourceRelationshipRecordType(Type resourceRelationshipRecordType)	Tests if the given ResourceRelationship record type is supported.
boolean	supportsResourceRelationshipSearch()	Tests if searching resource relationships is supported.
boolean	supportsResourceRelationshipSearchRecordType(Type resourceRelationshipSearchRecordType)	Tests if the given ResourceRelationship search record type is supported.
boolean	supportsResourceRelationshipSmartBin()	Tests if resource relationship smart bins are available.
boolean	supportsResourceSearch()	Tests if resource search is supported.
boolean	supportsResourceSearchRecordType(Type resourceSearchRecordType)	Tests if a given resource search type is supported.
boolean	supportsResourceSmartBin()	Tests if resource smart bins are available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

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.

Method Details

getResourceLookupSession

ResourceLookupSession getResourceLookupSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the resource lookup service.

Parameters:

proxy - a proxy

Returns:

a ResourceLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLookup() is false

Compliance:

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

getResourceLookupSessionForBin

ResourceLookupSession getResourceLookupSessionForBin(Id binId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the resource lookup service for the given bin.

Parameters:

binId - the Id of the bin

proxy - a proxy

Returns:

a ResourceLookupSession

Throws:

NotFoundException - binId not found

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLookup() or supportsVisibleFederation() is false

Compliance:

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

getResourceQuerySession

ResourceQuerySession getResourceQuerySession(Proxy proxy)
                                      throws OperationFailedException

Gets a resource query session.

Parameters:

proxy - a proxy

Returns:

a ResourceQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceQuery() is false

Compliance:

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

getResourceQuerySessionForBin

ResourceQuerySession getResourceQuerySessionForBin(Id binId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets a resource query session for the given bin.

Parameters:

binId - the Id of the bin

proxy - a proxy

Returns:

a ResourceQuerySession

Throws:

NotFoundException - binId not found

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceQuery() or supportsVisibleFederation() is false

Compliance:

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

getResourceSearchSession

ResourceSearchSession getResourceSearchSession(Proxy proxy)
                                        throws OperationFailedException

Gets a resource search session.

Parameters:

proxy - a proxy

Returns:

a ResourceSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceSearch() is false

Compliance:

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

getResourceSearchSessionForBin

ResourceSearchSession getResourceSearchSessionForBin(Id binId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets a resource search session for the given bin.

Parameters:

binId - the Id of the bin

proxy - a proxy

Returns:

a ResourceSearchSession

Throws:

NotFoundException - binId not found

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceSearch() or supportsVisibleFederation() is false

Compliance:

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

getResourceAdminSession

ResourceAdminSession getResourceAdminSession(Proxy proxy)
                                      throws OperationFailedException

Gets a resource administration session for creating, updating and deleting resources.

Parameters:

proxy - a proxy

Returns:

a ResourceAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceAdmin() is false

Compliance:

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

getResourceAdminSessionForBin

ResourceAdminSession getResourceAdminSessionForBin(Id binId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets a resource administration session for the given bin.

Parameters:

binId - the Id of the bin

proxy - a proxy

Returns:

a ResourceAdminSession

Throws:

NotFoundException - binId not found

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceAdmin() or supportsVisibleFederation() is false

Compliance:

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

getResourceNotificationSession

ResourceNotificationSession getResourceNotificationSession(ResourceReceiver resourceReceiver,
 Proxy proxy)
                                                    throws OperationFailedException

Gets the resource notification session for the given bin.

Parameters:

resourceReceiver - notification callback

proxy - a proxy

Returns:

a ResourceNotificationSession

Throws:

NullArgumentException - resourceReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceNotification() is false

Compliance:

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

getResourceNotificationSessionForBin

ResourceNotificationSession getResourceNotificationSessionForBin(ResourceReceiver resourceReceiver,
 Id binId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

Gets the resource notification session for the given bin.

Parameters:

resourceReceiver - notification callback

binId - the Id of the bin

proxy - a proxy

Returns:

a ResourceNotificationSession

Throws:

NotFoundException - binId not found

NullArgumentException - resourceReceiver, binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceNotification() or supportsVisibleFederation() is false

Compliance:

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

getResourceBinSession

ResourceBinSession getResourceBinSession(Proxy proxy)
                                  throws OperationFailedException

Gets the session for retrieving resource to bin mappings.

Parameters:

proxy - a proxy

Returns:

a ResourceBinSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceBin() is false

Compliance:

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

getResourceBinAssignmentSession

ResourceBinAssignmentSession getResourceBinAssignmentSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the session for assigning resource to bin mappings.

Parameters:

proxy - a proxy

Returns:

a ResourceBinAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceBinAssignment() is false

Compliance:

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

getResourceSmartBinSession

ResourceSmartBinSession getResourceSmartBinSession(Id binId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic resource bins.

Parameters:

binId - the Id of the bin

proxy - a proxy

Returns:

a ResourceSmartBinSession

Throws:

NotFoundException - binId not found

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceSmartBin() is false

Compliance:

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

getMembershipSession

MembershipSession getMembershipSession(Proxy proxy)
                                throws OperationFailedException

Gets the session for querying memberships.

Parameters:

proxy - a proxy

Returns:

a MembershipSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMembership() is false

Compliance:

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

getMembershipSessionForBin

MembershipSession getMembershipSessionForBin(Id binId,
 Proxy proxy)
                                      throws NotFoundException,
OperationFailedException

Gets a resource membership session for the given bin.

Parameters:

binId - the Id of the bin

proxy - a proxy

Returns:

a MembershipSession

Throws:

NotFoundException - binId not found

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMembership() or supportsVisibleFederation() is false

Compliance:

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

getGroupSession

GroupSession getGroupSession(Proxy proxy)
                      throws OperationFailedException

Gets the session for retrieving gropup memberships.

Parameters:

proxy - a proxy

Returns:

a GroupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGroups() is false

Compliance:

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

getGroupSessionForBin

GroupSession getGroupSessionForBin(Id binId,
 Proxy proxy)
                            throws NotFoundException,
OperationFailedException

Gets a group session for the given bin.

Parameters:

binId - the Id of the bin

proxy - a proxy

Returns:

a GroupSession

Throws:

NotFoundException - binId not found

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGroup() or supportsVisibleFederation() is false

Compliance:

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

getGroupAssignmentSession

GroupAssignmentSession getGroupAssignmentSession(Proxy proxy)
                                          throws OperationFailedException

Gets the session for assigning resources to groups.

Parameters:

proxy - a proxy

Returns:

a GroupAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGroupAssignment() is false

Compliance:

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

getGroupAssignmentSessionForBin

GroupAssignmentSession getGroupAssignmentSessionForBin(Id binId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

Gets a group assignment session for the given bin.

Parameters:

binId - the Id of the bin

proxy - a proxy

Returns:

a GroupAssignmentSession

Throws:

NotFoundException - binId not found

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGroupAssignment() or supportsVisibleFederation() is false

Compliance:

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

getGroupNotificationSession

GroupNotificationSession getGroupNotificationSession(GroupReceiver groupRceeiver,
 Proxy proxy)
                                              throws OperationFailedException

Gets the notification session for notifications pertaining to resource changes.

Parameters:

groupRceeiver - the notification callback

proxy - a proxy

Returns:

a GroupNotificationSession

Throws:

NullArgumentException - groupReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGroupNotification() is false

Compliance:

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

getGroupNotificationSessionForBin

GroupNotificationSession getGroupNotificationSessionForBin(GroupReceiver groupRceeiver,
 Id binId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

Gets the group notification session for the given bin.

Parameters:

groupRceeiver - the notification callback

binId - the Id of the bin

proxy - a proxy

Returns:

a GroupNotificationSession

Throws:

NotFoundException - binId not found

NullArgumentException - groupReceiver, binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGroupNotification() or supportsVisibleFederation() is false

Compliance:

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

getGroupHierarchySession

BinHierarchySession getGroupHierarchySession(Proxy proxy)
                                      throws OperationFailedException

Gets the group hierarchy traversal session for the given resource group.

Parameters:

proxy - a proxy

Returns:

a GroupHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGroupHierarchy() is false

Compliance:

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

getGroupHierarchySessionForBin

GroupHierarchySession getGroupHierarchySessionForBin(Id binId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets a group hierarchy session for the given bin.

Parameters:

binId - the Id of the bin

proxy - a proxy

Returns:

a GroupHierarchySession

Throws:

NotFoundException - binId not found

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGroupHierarchy() or supportsVisibleFederation() is false

Compliance:

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

getResourceAgentSession

ResourceAgentSession getResourceAgentSession(Proxy proxy)
                                      throws OperationFailedException

Gets the session for retrieving resource agent mappings.

Parameters:

proxy - a proxy

Returns:

a GroupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceAgents() is false

Compliance:

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

getResourceAgentSessionForBin

ResourceAgentSession getResourceAgentSessionForBin(Id binId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets a resource agent session for the given bin.

Parameters:

binId - the Id of the bin

proxy - a proxy

Returns:

a ResourceAgentSession

Throws:

NotFoundException - binId not found

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceAgent() or supportsVisibleFederation() is false

Compliance:

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

getResourceAgentAssignmentSession

ResourceAgentAssignmentSession getResourceAgentAssignmentSession(Proxy proxy)
                                                          throws OperationFailedException

Gets the session for assigning agents to resources.

Parameters:

proxy - a proxy

Returns:

a ResourceAgentAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceAgentAssignment() is false

Compliance:

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

getResourceAgentAssignmentSessionForBin

ResourceAgentAssignmentSession getResourceAgentAssignmentSessionForBin(Id binId,
 Proxy proxy)
                                                                throws NotFoundException,
OperationFailedException

Gets a resource agent session for the given bin.

Parameters:

binId - the Id of the Bin

proxy - a proxy

Returns:

a ResourceAgentAssignmentSession

Throws:

NotFoundException - binId not found

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceAgentAssignment() or supportsVisibleFederation() is false

Compliance:

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

getResourceRelationshipLookupSession

ResourceRelationshipLookupSession getResourceRelationshipLookupSession(Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with the resource relationship lookup service.

Parameters:

proxy - a proxy

Returns:

a ResourceRelationshipLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipLookup() is false

Compliance:

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

getResourceRelationshipLookupSessionForBin

ResourceRelationshipLookupSession getResourceRelationshipLookupSessionForBin(Id binId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the resource relationship lookup service for the given bin.

Parameters:

binId - the Id of the Bin

proxy - a proxy

Returns:

a ResourceRelationshipLookupSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipLookup() or supportsVisibleFederation() is false

Compliance:

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

getResourceRelationshipQuerySession

ResourceRelationshipQuerySession getResourceRelationshipQuerySession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the resource relationship query service.

Parameters:

proxy - a proxy

Returns:

a ResourceRelationshipQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipQuery() is false

Compliance:

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

getResourceRelationshipQuerySessionForBin

ResourceRelationshipQuerySession getResourceRelationshipQuerySessionForBin(Id binId,
 Proxy proxy)
                                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the resource relationship query service for the given bin.

Parameters:

binId - the Id of the Bin

proxy - a proxy

Returns:

a ResourceRelationshipQuerySession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipQuery() or supportsVisibleFederation() is false

Compliance:

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

getResourceRelationshipSearchSession

ResourceRelationshipSearchSession getResourceRelationshipSearchSession(Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with the resource relationship search service.

Parameters:

proxy - a proxy

Returns:

a ResourceRelationshipSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipSearch() is false

Compliance:

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

getResourceRelationshipSearchSessionForBin

ResourceRelationshipSearchSession getResourceRelationshipSearchSessionForBin(Id binId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the resource relationship search service for the given bin.

Parameters:

binId - the Id of the Bin

proxy - a proxy

Returns:

a ResourceRelationshipSearchSession

Throws:

NotFoundException - no bin found by the given Id

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipSearch() or supportsVisibleFederation() is false

Compliance:

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

getResourceRelationshipAdminSession

ResourceRelationshipAdminSession getResourceRelationshipAdminSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the resource relationship administration service.

Parameters:

proxy - a proxy

Returns:

a ResourceRelationshipAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipAdmin() is false

Compliance:

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

getResourceRelationshipAdminSessionForBin

ResourceRelationshipAdminSession getResourceRelationshipAdminSessionForBin(Id binId,
 Proxy proxy)
                                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the resource relationship administration service for the given bin.

Parameters:

binId - the Id of the Bin

proxy - a proxy

Returns:

a ResourceRelationshipAdminSession

Throws:

NotFoundException - no bin found by the given Id

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipAdmin() or supportsVisibleFederation() is false

Compliance:

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

getResourceRelationshipNotificationSession

ResourceRelationshipNotificationSession getResourceRelationshipNotificationSession(ResourceRelationshipReceiver resourceRelationshipReceiver,
 Proxy proxy)
                                                                            throws OperationFailedException

Gets the OsidSession associated with the resource relationship notification service.

Parameters:

resourceRelationshipReceiver - the notification callback

proxy - a proxy

Returns:

a ResourceRelationshipNotificationSession

Throws:

NullArgumentException - resourceRelationshipReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipNotification() is false

Compliance:

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

getResourceRelationshipNotificationSessionForBin

ResourceRelationshipNotificationSession getResourceRelationshipNotificationSessionForBin(ResourceRelationshipReceiver resourceRelationshipReceiver,
 Id binId,
 Proxy proxy)
                                                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the resource relationship notification service for the given bin.

Parameters:

resourceRelationshipReceiver - the notification callback

binId - the Id of the Bin

proxy - a proxy

Returns:

a ResourceRelationshipNotificationSession

Throws:

NotFoundException - no bin found by the given Id

NullArgumentException - resourceRelationshipReceiver, binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshiptNotification() or supportsVisibleFederation() is false

Compliance:

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

getResourceRelationshipBinSession

ResourceRelationshipBinSession getResourceRelationshipBinSession(Proxy proxy)
                                                          throws OperationFailedException

Gets the session for retrieving resource relationship to bin mappings.

Parameters:

proxy - a proxy

Returns:

a ResourceRelationshipBinSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipBin() is false

Compliance:

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

getResourceRelationshipBinAssignmentSession

ResourceRelationshipBinAssignmentSession getResourceRelationshipBinAssignmentSession(Proxy proxy)
                                                                              throws OperationFailedException

Gets the session for assigning resource relationship to bin mappings.

Parameters:

proxy - a proxy

Returns:

a ResourceRelationshipBinAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipBinAssignment() is false

Compliance:

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

getResourceRelationshipSmartBinSession

ResourceRelationshipSmartBinSession getResourceRelationshipSmartBinSession(Id binId,
 Proxy proxy)
                                                                    throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic resource relationship bins.

Parameters:

binId - the Id of the bin

proxy - a proxy

Returns:

a ResourceRelationshipSmartBinSession

Throws:

NotFoundException - binId not found

NullArgumentException - binId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRelationshipSmartBin() is false

Compliance:

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

getBinLookupSession

BinLookupSession getBinLookupSession(Proxy proxy)
                              throws OperationFailedException

Gets the bin lookup session.

Parameters:

proxy - a proxy

Returns:

a BinLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBinLookup() is false

Compliance:

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

getBinQuerySession

BinQuerySession getBinQuerySession(Proxy proxy)
                            throws OperationFailedException

Gets the bin query session.

Parameters:

proxy - a proxy

Returns:

a BinQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBinQuery() is false

Compliance:

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

getBinSearchSession

BinSearchSession getBinSearchSession(Proxy proxy)
                              throws OperationFailedException

Gets the bin search session.

Parameters:

proxy - a proxy

Returns:

a BinSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBinSearch() is false

Compliance:

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

getBinAdminSession

BinAdminSession getBinAdminSession(Proxy proxy)
                            throws OperationFailedException

Gets the bin administrative session for creating, updating and deleteing bins.

Parameters:

proxy - a proxy

Returns:

a BinAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBinAdmin() is false

Compliance:

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

getBinNotificationSession

BinNotificationSession getBinNotificationSession(BinReceiver binReceiver,
 Proxy proxy)
                                          throws OperationFailedException

Gets the notification session for subscribing to changes to a bin.

Parameters:

binReceiver - notification callback

proxy - a proxy

Returns:

a BinNotificationSession

Throws:

NullArgumentException - binReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBinNotification() is false

Compliance:

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

getBinHierarchySession

BinHierarchySession getBinHierarchySession(Proxy proxy)
                                    throws OperationFailedException,
PermissionDeniedException

Gets the bin hierarchy traversal session.

Parameters:

proxy - a proxy

Returns:

a BinHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnimplementedException - supportsBinHierarchy() is false

Compliance:

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

getBinHierarchyDesignSession

BinHierarchyDesignSession getBinHierarchyDesignSession(Proxy proxy)
                                                throws OperationFailedException,
PermissionDeniedException

Gets the bin hierarchy design session.

Parameters:

proxy - a proxy

Returns:

a BinHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnimplementedException - supportsBinHierarchyDesign() is false

Compliance:

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

getResourceBatchProxyManager

ResourceBatchProxyManager getResourceBatchProxyManager()
                                                throws OperationFailedException

Gets the ResourceBatchProxyManager .

Returns:

a ResourceBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceBatch() is false

Compliance:

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

getResourceDemographicProxyManager

ResourceDemographicProxyManager getResourceDemographicProxyManager()
                                                            throws OperationFailedException

Gets the ResourceDemographicProxyManager .

Returns:

a ResourceDemographicProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceDemographic() is false

Compliance:

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