Interface PostEntry

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, Subjugateable
public interface PostEntry extends OsidObject, Subjugateable

A PostEntry is a debit or a credit made to an Account and Activity .

  • Method Details

    • getPostId

      Id getPostId()
      Gets the post Id to which this entry belongs.
      Returns:
      the payer Id
      Compliance:
      mandatory - This method must be implemented.

    • getPost

      Post getPost() throws OperationFailedException
      Gets the post to which this entry belongs.
      Returns:
      the post
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAccountId

      Id getAccountId()
      Gets the G/L account Id to which this entry applies.
      Returns:
      the account Id
      Compliance:
      mandatory - This method must be implemented.

    • getAccount

      Account getAccount() throws OperationFailedException
      Gets the G/L account to which this entry applies.
      Returns:
      the account
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getActivityId

      Id getActivityId()
      Gets the financial activity Id to which this entry applies.
      Returns:
      the activity Id
      Compliance:
      mandatory - This method must be implemented.

    • getActivity

      Activity getActivity() throws OperationFailedException
      Gets the financial activity to which this entry applies.
      Returns:
      the activity
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAmount

      Currency getAmount()
      Gets the amount.
      Returns:
      the amount
      Compliance:
      mandatory - This method must be implemented.

    • isDebit

      boolean isDebit()
      Tests if the amount is a debit or a credit.
      Returns:
      true if this entry amount is a debit, false if it is a credit
      Compliance:
      mandatory - This method must be implemented.

    • getPostEntryRecord

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