Interface Activity

All Superinterfaces:
Browsable, Extensible, Federateable, Identifiable, OsidObject, Temporal
public interface Activity extends OsidObject, Federateable, Temporal

An Activity represents a cost object for an organization unit, project, or activity.

  • Method Details

    • getOrganizationId

      Id getOrganizationId()
      Gets the organization Id associated with this activity.
      Returns:
      the organization Id
      Compliance:
      mandatory - This method must be implemented.

    • getOrganization

      Resource getOrganization() throws OperationFailedException
      Gets the organization associated with this activity.
      Returns:
      the organization
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSupervisorId

      Id getSupervisorId()
      Gets the resource Id supervising this activity account.
      Returns:
      the resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getSupervisor

      Resource getSupervisor() throws OperationFailedException
      Gets the resource supervising this activity account.
      Returns:
      the resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getCode

      String getCode()
      Gets the code for this activity account.
      Returns:
      the activity code
      Compliance:
      mandatory - This method must be implemented.

    • getActivityRecord

      ActivityRecord getActivityRecord(Type activityRecordType) throws OperationFailedException
      Gets the activity record corresponding to the given Activity record Type .This method is used to retrieve an object implementing the requested record. The activityRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(activityRecordType) is true .
      Parameters:
      activityRecordType - the type of activity record to retrieve
      Returns:
      the activity record
      Throws:
      NullArgumentException - activityRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(activityRecordType) is false
      Compliance:
      mandatory - This method must be implemented.