| Interface | osid.resource.ResourceProxyManager | ||
|---|---|---|---|
| Implements | osid.OsidProxyManager | ||
osid.resource.ResourceProfile | |||
| Description | 
                 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  
 
 
  | ||
| Method | getResourceLookupSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceLookupSession |  a ResourceLookupSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceLookup()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceLookup()  
is  true.   | |
| Method | getResourceLookupSessionForBin | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | binId | the  Id  of the bin  | 
osid.proxy.Proxy | proxy |  a proxy   | |
| Return | osid.resource.ResourceLookupSession |  a ResourceLookupSession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED |  unable to complete request   |                 ||
| UNIMPLEMENTED |  supportsResourceLookup()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceLookup()  
and  supportsVisibleFederation()  are  true.   | |
| Method | getResourceQuerySession | ||
| Description | 
                     Gets a resource query session.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceQuerySession |  a ResourceQuerySession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceQuery()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceQuery()  
is  true.   | |
| Method | getResourceQuerySessionForBin | ||
| Description | 
                     Gets a resource query session for the given bin.  | ||
| Parameters | osid.id.Id | binId | the  Id  of the bin  | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceQuerySession |  a ResourceQuerySession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED |  unable to complete request   |                 ||
| UNIMPLEMENTED |  supportsResourceQuery()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceQuery()  
and  supportsVisibleFederation()  are  true.   | |
| Method | getResourceSearchSession | ||
| Description | 
                     Gets a resource search session.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceSearchSession |  a ResourceSearchSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceSearch()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceSearch()  
is  true.   | |
| Method | getResourceSearchSessionForBin | ||
| Description | 
                     Gets a resource search session for the given bin.  | ||
| Parameters | osid.id.Id | binId | the  Id  of the bin  | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceSearchSession |  a ResourceSearchSession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED |  unable to complete request   |                 ||
| UNIMPLEMENTED |  supportsResourceSearch()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceSearch()  
and  supportsVisibleFederation()  are  true.   | |
| Method | getResourceAdminSession | ||
| Description | 
                     Gets a resource administration session for creating, updating and deleting resources.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceAdminSession |  a ResourceAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceAdmin()  
is  true.   | |
| Method | getResourceAdminSessionForBin | ||
| Description | 
                     Gets a resource administration session for the given bin.  | ||
| Parameters | osid.id.Id | binId | the  Id  of the bin  | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceAdminSession |  a ResourceAdminSession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceAdmin()  
and  supportsVisibleFederation()  are  true.   | |
| Method | getResourceNotificationSession | ||
| Description | 
                     Gets the resource notification session for the given bin.  | ||
| Parameters | osid.resource.ResourceReceiver | resourceReceiver | notification callback | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceNotificationSession |  a ResourceNotificationSession   | |
| Errors | NULL_ARGUMENT |  resourceReceiver  or  proxy  is  null 
  |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceNotification()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceNotification() 
 is  true.   | |
| Method | getResourceNotificationSessionForBin | ||
| Description | 
                     Gets the resource notification session for the given bin.  | ||
| Parameters | osid.resource.ResourceReceiver | resourceReceiver | notification callback | 
osid.id.Id | binId | the  Id  of the bin  | |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceNotificationSession |  a ResourceNotificationSession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  resourceReceiver, binId  or  proxy  is  
null   |                 ||
| OPERATION_FAILED |  unable to complete request   |                 ||
| UNIMPLEMENTED |  supportsResourceNotification()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceNotfication() 
 and  supportsVisibleFederation()  are  true. 
  | |
| Method | getResourceBinSession | ||
| Description | 
                     Gets the session for retrieving resource to bin mappings.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceBinSession | a  ResourceBinSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceBin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceBin()  is 
 true.   | |
| Method | getResourceBinAssignmentSession | ||
| Description | 
                     Gets the session for assigning resource to bin mappings.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceBinAssignmentSession | a  ResourceBinAssignmentSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceBinAssignment()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceBinAssignment() 
 is  true.   | |
| Method | getResourceSmartBinSession | ||
| Description | 
                     Gets the session for managing dynamic resource bins.  | ||
| Parameters | osid.id.Id | binId | the  Id  of the bin  | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceSmartBinSession | a  ResourceSmartBinSession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceSmartBin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceSmartBin() 
 is  true.   | |
| Method | getMembershipSession | ||
| Description | 
                     Gets the session for querying memberships.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.MembershipSession | a  MembershipSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsMembership()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportMembership()  is 
 true.   | |
| Method | getMembershipSessionForBin | ||
| Description | 
                     Gets a resource membership session for the given bin.  | ||
| Parameters | osid.id.Id | binId | the  Id  of the bin  | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.MembershipSession |  a MembershipSession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsMembership()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsMembership()  and 
 supportsVisibleFederation()  are  true.   | |
| Method | getGroupSession | ||
| Description | 
                     Gets the session for retrieving gropup memberships.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.GroupSession | a  GroupSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsGroups()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsGroups()  is 
 true.   | |
| Method | getGroupSessionForBin | ||
| Description | 
                     Gets a group session for the given bin.  | ||
| Parameters | osid.id.Id | binId | the  Id  of the bin  | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.GroupSession | a  GroupSession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsGroup()  or  supportsVisibleFederation() 
 is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsGroup()  and 
 supportsVisibleFederation()  are  true.   | |
| Method | getGroupAssignmentSession | ||
| Description | 
                     Gets the session for assigning resources to groups.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.GroupAssignmentSession | a  GroupAssignmentSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsGroupAssignment()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsGroupAssignment()  
is  true.   | |
| Method | getGroupAssignmentSessionForBin | ||
| Description | 
                     Gets a group assignment session for the given bin.  | ||
| Parameters | osid.id.Id | binId | the  Id  of the bin  | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.GroupAssignmentSession | a  GroupAssignmentSession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsGroupAssignment()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsGroupAssignment()  
and  supportsVisibleFederation()  are  true.   | |
| Method | getGroupNotificationSession | ||
| Description | 
                     Gets the notification session for notifications pertaining to resource changes.  | ||
| Parameters | osid.resource.GroupReceiver | groupRceeiver | the notification callback | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.GroupNotificationSession |  a GroupNotificationSession   | |
| Errors | NULL_ARGUMENT |  groupReceiver  or  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsGroupNotification()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsGroupNotification() 
 is  true.   | |
| Method | getGroupNotificationSessionForBin | ||
| Description | 
                     Gets the group notification session for the given bin.  | ||
| Parameters | osid.resource.GroupReceiver | groupRceeiver | the notification callback | 
osid.id.Id | binId | the  Id  of the bin  | |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.GroupNotificationSession |  a GroupNotificationSession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  groupReceiver, binId  or  proxy  is  null 
  |                 ||
| OPERATION_FAILED |  unable to complete request   |                 ||
| UNIMPLEMENTED |  supportsGroupNotification()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsGroupNotfication() 
 and  supportsVisibleFederation()  are  true. 
  | |
| Method | getGroupHierarchySession | ||
| Description | 
                     Gets the group hierarchy traversal session for the given resource group.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.BinHierarchySession |  a GroupHierarchySession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsGroupHierarchy()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsGroupHierarchy()  
is  true.   | |
| Method | getGroupHierarchySessionForBin | ||
| Description | 
                     Gets a group hierarchy session for the given bin.  | ||
| Parameters | osid.id.Id | binId | the  Id  of the bin  | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.GroupHierarchySession | a  GroupHierarchySession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsGroupHierarchy()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsGroupHierarchy()  
and  supportsVisibleFederation()  are  true.   | |
| Method | getResourceAgentSession | ||
| Description | 
                     Gets the session for retrieving resource agent mappings.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceAgentSession | a  GroupSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceAgents()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceAgents()  
is  true.   | |
| Method | getResourceAgentSessionForBin | ||
| Description | 
                     Gets a resource agent session for the given bin.  | ||
| Parameters | osid.id.Id | binId | the  Id  of the bin  | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceAgentSession | a  ResourceAgentSession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceAgent()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceAgent()  
and  supportsVisibleFederation()  are  true.   | |
| Method | getResourceAgentAssignmentSession | ||
| Description | 
                     Gets the session for assigning agents to resources.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceAgentAssignmentSession | a  ResourceAgentAssignmentSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceAgentAssignment()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceAgentAssignment() 
 is  true.   | |
| Method | getResourceAgentAssignmentSessionForBin | ||
| Description | 
                     Gets a resource agent session for the given bin.  | ||
| Parameters | osid.id.Id | binId | the  Id  of the  Bin   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceAgentAssignmentSession | a  ResourceAgentAssignmentSession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceAgentAssignment()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceAgentAssignment() 
 and  supportsVisibleFederation()  are  true. 
  | |
| Method | getResourceRelationshipLookupSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceRelationshipLookupSession | a  ResourceRelationshipLookupSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceRelationshipLookup()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  
supportsResourceRelationshipLookup()  is  true.   | |
| Method | getResourceRelationshipLookupSessionForBin | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | binId | the  Id  of the  Bin   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceRelationshipLookupSession | a  ResourceRelationshipLookupSession   | |
| Errors | NOT_FOUND | no  Bin  found by the given  Id   |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceRelationshipLookup()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  
supportsResourceRelationshipLookup()  and  
supportsVisibleFederation()  are  true   | |
| Method | getResourceRelationshipQuerySession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceRelationshipQuerySession | a  ResourceRelationshipQuerySession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceRelationshipQuery()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  
supportsResourceRelationshipQuery()  is  true.   | |
| Method | getResourceRelationshipQuerySessionForBin | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | binId | the  Id  of the  Bin   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceRelationshipQuerySession | a  ResourceRelationshipQuerySession   | |
| Errors | NOT_FOUND | no  Bin  found by the given  Id   |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceRelationshipQuery()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  
supportsResourceRelationshipQuery()  and  
supportsVisibleFederation()  are  true   | |
| Method | getResourceRelationshipSearchSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceRelationshipSearchSession | a  ResourceRelationshipSearchSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceRelationshipSearch()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  
supportsResourceRelationshipSearch()  is  true.   | |
| Method | getResourceRelationshipSearchSessionForBin | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | binId | the  Id  of the  Bin   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceRelationshipSearchSession | a  ResourceRelationshipSearchSession   | |
| Errors | NOT_FOUND | no bin found by the given  Id   |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceRelationshipSearch()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  
supportsResourceRelationshipSearch()  and  
supportsVisibleFederation()  are  true   | |
| Method | getResourceRelationshipAdminSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceRelationshipAdminSession | a  ResourceRelationshipAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceRelationshipAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  
supportsResourceRelationshipAdmin()  is  true.   | |
| Method | getResourceRelationshipAdminSessionForBin | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | binId | the  Id  of the  Bin   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceRelationshipAdminSession | a  ResourceRelationshipAdminSession   | |
| Errors | NOT_FOUND | no bin found by the given  Id   |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceRelationshipAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  
supportsResourceRelationshipAdmin()  and  
supportsVisibleFederation()  are  true   | |
| Method | getResourceRelationshipNotificationSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.resource.ResourceRelationshipReceiver | resourceRelationshipReceiver | the notification callback | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceRelationshipNotificationSession | a  ResourceRelationshipNotificationSession   | |
| Errors | NULL_ARGUMENT |  resourceRelationshipReceiver  or  proxy  is 
 null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceRelationshipNotification()  is  false 
  |                 ||
| Compliance | optional | This method must be implemented if  
supportsResourceRelationshipNotification()  is  true.   | |
| Method | getResourceRelationshipNotificationSessionForBin | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.resource.ResourceRelationshipReceiver | resourceRelationshipReceiver | the notification callback | 
osid.id.Id | binId | the  Id  of the  Bin   | |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceRelationshipNotificationSession | a  ResourceRelationshipNotificationSession   | |
| Errors | NOT_FOUND | no bin found by the given  Id   |                 |
| NULL_ARGUMENT |  resourceRelationshipReceiver, binId  or  proxy  
is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceRelationshiptNotification()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  
supportsResourceRelationshipNotification()  and  
supportsVisibleFederation()  are  true   | |
| Method | getResourceRelationshipBinSession | ||
| Description | 
                     Gets the session for retrieving resource relationship to bin mappings.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceRelationshipBinSession | a  ResourceRelationshipBinSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceRelationshipBin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceRelationshipBin() 
 is  true.   | |
| Method | getResourceRelationshipBinAssignmentSession | ||
| Description | 
                     Gets the session for assigning resource relationship to bin mappings.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.ResourceRelationshipBinAssignmentSession | a  ResourceRelationshipBinAssignmentSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceRelationshipBinAssignment()  is  false 
  |                 ||
| Compliance | optional | This method must be implemented if  
supportsResourceRelationshipBinAssignment()  is  true.   | |
| Method | getResourceRelationshipSmartBinSession | ||
| Description | 
                     Gets the session for managing dynamic resource relationship bins.  | ||
| Parameters | osid.id.Id | binId | the  Id  of the bin  | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.ResourceRelationshipSmartBinSession | a  ResourceRelationshipSmartBinSession   | |
| Errors | NOT_FOUND |  binId  not found  |                 |
| NULL_ARGUMENT |  binId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsResourceRelationshipSmartBin()  is  false 
  |                 ||
| Compliance | optional | This method must be implemented if  
supportsResourceRelationshipSmartBin()  is  true.   | |
| Method | getBinLookupSession | ||
| Description | 
                     Gets the bin lookup session.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.BinLookupSession | a  BinLookupSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsBinLookup()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBinLookup()  is 
 true.   | |
| Method | getBinQuerySession | ||
| Description | 
                     Gets the bin query session.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.BinQuerySession | a  BinQuerySession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsBinQuery()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBinQuery()  is 
 true.   | |
| Method | getBinSearchSession | ||
| Description | 
                     Gets the bin search session.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.BinSearchSession | a  BinSearchSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsBinSearch()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBinSearch()  is 
 true.   | |
| Method | getBinAdminSession | ||
| Description | 
                     Gets the bin administrative session for creating, updating and deleteing bins.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.BinAdminSession | a  BinAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsBinAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBinAdmin()  is 
 true.   | |
| Method | getBinNotificationSession | ||
| Description | 
                     Gets the notification session for subscribing to changes to a bin.  | ||
| Parameters | osid.resource.BinReceiver | binReceiver | notification callback | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resource.BinNotificationSession | a  BinNotificationSession   | |
| Errors | NULL_ARGUMENT |  binReceiver  or  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsBinNotification()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBinNotification()  
is  true.   | |
| Method | getBinHierarchySession | ||
| Description | 
                     Gets the bin hierarchy traversal session.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.BinHierarchySession |  a BinHierarchySession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNIMPLEMENTED |  supportsBinHierarchy()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBinHierarchy()  is 
 true.   | |
| Method | getBinHierarchyDesignSession | ||
| Description | 
                     Gets the bin hierarchy design session.  | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.resource.BinHierarchyDesignSession | a  BinHierarchyDesignSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNIMPLEMENTED |  supportsBinHierarchyDesign()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBinHierarchyDesign() 
 is  true.   | |
| Method | getResourceBatchProxyManager | ||
| Description | 
                     Gets the   | ||
| Return | osid.resource.batch.ResourceBatchProxyManager | a  ResourceBatchProxyManager   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsResourceBatch()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceBatch()  
is  true.   | |
| Method | getResourceDemographicProxyManager | ||
| Description | 
                     Gets the   | ||
| Return | osid.resource.demographic.ResourceDemographicProxyManager | a  ResourceDemographicProxyManager   | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED |  supportsResourceDemographic()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsResourceDemographic() 
 is  true.   | |