org.osid.resource

Interface ResourceProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.resource.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

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

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 supportsResourceLookup() is 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 supportsResourceLookup() and supportsVisibleFederation() are 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 supportsResourceQuery() is 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 supportsResourceQuery() and supportsVisibleFederation() are 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 supportsResourceSearch() is 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 supportsResourceSearch() and supportsVisibleFederation() are 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 supportsResourceAdmin() is 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 supportsResourceAdmin() and supportsVisibleFederation() are 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 supportsResourceNotification() is 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 supportsResourceNotfication() and supportsVisibleFederation() are 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 supportsResourceBin() is 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 supportsResourceBinAssignment() is 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 supportsResourceSmartBin() is 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 supportMembership() is 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 supportsMembership() and supportsVisibleFederation() are 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 supportsGroups() is 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 supportsGroup() and supportsVisibleFederation() are 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 supportsGroupAssignment() is 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 supportsGroupAssignment() and supportsVisibleFederation() are 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 supportsGroupNotification() is 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 supportsGroupNotfication() and supportsVisibleFederation() are 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 supportsGroupHierarchy() is 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 supportsGroupHierarchy() and supportsVisibleFederation() are 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 supportsResourceAgents() is 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 supportsResourceAgent() and supportsVisibleFederation() are 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 supportsResourceAgentAssignment() is 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 supportsResourceAgentAssignment() and supportsVisibleFederation() are 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 supportsResourceRelationshipLookup() is 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 supportsResourceRelationshipLookup() and supportsVisibleFederation() are 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 supportsResourceRelationshipQuery() is 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 supportsResourceRelationshipQuery() and supportsVisibleFederation() are 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 supportsResourceRelationshipSearch() is 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 supportsResourceRelationshipSearch() and supportsVisibleFederation() are 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 supportsResourceRelationshipAdmin() is 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 supportsResourceRelationshipAdmin() and supportsVisibleFederation() are 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 supportsResourceRelationshipNotification() is 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 supportsResourceRelationshipNotification() and supportsVisibleFederation() are 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 supportsResourceRelationshipBin() is 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 supportsResourceRelationshipBinAssignment() is 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 supportsResourceRelationshipSmartBin() is 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 supportsBinLookup() is 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 supportsBinQuery() is 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 supportsBinSearch() is 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 supportsBinAdmin() is 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 supportsBinNotification() is 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 supportsBinHierarchy() is 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 supportsBinHierarchyDesign() is 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 supportsResourceBatch() is 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 supportsResourceDemographic() is true.