Interface CourseProgramBatchProxyManager

All Superinterfaces:
AutoCloseable, Closeable, CourseProgramBatchProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable
public interface CourseProgramBatchProxyManager extends OsidProxyManager, CourseProgramBatchProfile

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

  • ProgramBatchAdminSession : a session to create, modify and delete programs in bulk
  • ProgramOfferingBatchAdminSession : a session to create, modify and delete program offerings in bulk
  • CredentialBatchAdminSession : a session to create, modify and delete credentials in bulk
  • EnrollmentBatchAdminSession : a session to create, modify and delete enrollments in bulk

  • Method Details

    • getProgramBatchAdminSession

      ProgramBatchAdminSession getProgramBatchAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk program administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a ProgramBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramBatchAdmin()} is {@code true} .

    • getProgramBatchAdminSessionForCourseCatalog

      ProgramBatchAdminSession getProgramBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk program administration service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      proxy - a proxy
      Returns:
      a ProgramBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getProgramOfferingBatchAdminSession

      ProgramOfferingBatchAdminSession getProgramOfferingBatchAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk program offering administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a ProgramOfferingBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramOfferingBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramOfferingBatchAdmin()} is {@code true} .

    • getProgramOfferingBatchAdminSessionForCourseCatalog

      ProgramOfferingBatchAdminSession getProgramOfferingBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk program offering administration service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      proxy - a proxy
      Returns:
      a ProgramOfferingBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramOfferingBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramOfferingBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getCredentialBatchAdminSession

      CredentialBatchAdminSession getCredentialBatchAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk credential administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a CredentialBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCredentialBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCredentialBatchAdmin()} is {@code true} .

    • getCredentialBatchAdminSessionForCourseCatalog

      CredentialBatchAdminSession getCredentialBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk credential administration service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      proxy - a proxy
      Returns:
      a CredentialBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCredentialBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCredentialBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getEnrollmentBatchAdminSession

      EnrollmentBatchAdminSession getEnrollmentBatchAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk enrollment administration service.
      Parameters:
      proxy - a proxy
      Returns:
      an EnrollmentBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsEnrollmentBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEnrollmentBatchAdmin()} is {@code true} .

    • getEnrollmentBatchAdminSessionForCourseCatalog

      EnrollmentBatchAdminSession getEnrollmentBatchAdminSessionForCourseCatalog(Id courseCatalogId, Proxy proxy) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk enrollment administration service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      proxy - a proxy
      Returns:
      an EnrollmentBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsEnrollmentBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEnrollmentBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}