Package com.oracle.communications.brm.cc.modules

Interface AccountModule

All Superinterfaces:
BaseModule
All Known Implementing Classes:
PCMAccountModule
public interface AccountModule extends BaseModule

  • Method Details

    • accountDetails

      Account accountDetails(String accountId, boolean retrieveDetails)
      Returns an existing BRM account
      Parameters:
      accountId - Specified using the REST ID format (db + unique object ID: i.e. 0.0.0.1-54321)
      retrieveDetails - retrieves the detailed account information if the values is true If more detailed account information is not needed then the retrieveDetails should be passed as false
      Returns:
      The account object

    • updateAccountGeneralInfo

      void updateAccountGeneralInfo(Account account) throws ApplicationException
      Updates account general information like contacts, security question and answer, account status, customer type and language
      Parameters:
      account - account object with updated general info data
      Throws:
      ApplicationException

    • saveTaxInfo

      void saveTaxInfo(String id, TaxInfo taxInfo)
      Save tax information
      Parameters:
      id - Account id
      taxInfo - String with tax informations

    • getTaxInfo

      TaxInfo getTaxInfo(String id)
      Retrieves tax information
      Parameters:
      id - Account id
      Returns:
      TaxInfo object with tax details of the account with accountId Id

    • createAccount

      String createAccount(RegistrationAccount registrationPayload)
      Creates a new subscriber account
      Parameters:
      registrationPayload - payload representing RegistrationAccount schema
      Returns:
      the account ID once the account creation is successful

    • subscribePackage

      void subscribePackage(String accountId, PackageBasedOrder order)
      Add new services to an existing account
      Parameters:
      accountId - id of an account to which a new plan needs to be added
      order - payload representing PackageBasedOrder schema

    • validateAccount

      void validateAccount(RegistrationAccount registrationPayload)
      Validates the subscriber account data
      Parameters:
      registrationPayload - payload representing RegistrationAccount schema

    • purchaseBundle

      void purchaseBundle(String id, CustomizedBundleForPurchase custbundle)
      Adds new bundle to an existing service or an account
      Parameters:
      id - represents the serviceid or the accountId(in case of account level bundles) to which the bundle needs to be added. This is a mandatory parameter
      custbundle - payload representing CustomizedBundleForPurchase schema

    • addAccountToHierarchy

      void addAccountToHierarchy(List<String> ids, String parentId)
      Parameters:
      ids -
      parentId -

    • moveHierarchy

      void moveHierarchy(List<String> childIds, String primaryId, String primaryParentId, String childrenParentId, boolean moveChildren)
      Parameters:
      childIds - represents the accountIds of the direct children accts.
      primaryId - Primary Node Account ID
      primaryParentId - account Id of the node in which primary node will move as a child
      childrenParentId - represents the accountId of the node in which direct children node will move as direct children
      moveChildren - flag to tell if operation is move children operation

    • removeAccountFromHierarchy

      void removeAccountFromHierarchy(List<String> childIds, String id, String childrenParentId, boolean removeChildren)
      Parameters:
      childIds -
      id - represents the accountId of the a/c to be removed from hierarchy. This is a mandatory parameter the method returns no response when the a/c is removed successfully on success;exception will be raised on failure, status 500 if the operation failed
      childrenParentId -
      removeChildren - flag to tell us if it is a remove children operation

    • getOrganizationHierarchy

      OrganizationHierarchy getOrganizationHierarchy(String accountId, boolean expandFlag)
      Return 'OrganizationHierarchy' payload represented by 'organizationHierarchy.xsd' for the requested account id. If the account Id in not in hierarchy then a empty instance will be returned.
      Parameters:
      accountId - Account Id for which organization hierarchy is to be retrieved
      expandFlag - when this flag is true we return child details, other wise we just return total number of child
      Returns:
      OrganizationHierarchy payload

    • getLimits

      BalanceGroup getLimits(String accountId, String balanceGroupId, String resourceId, String endDate)
      Get balance group with limits for a given account id
      Parameters:
      accountId - Account ID
      balanceGroupId - Balance group ID, to retrieve the specified balance group. this is an optional field if not passed default balanceGroup will be retrieved for the account.
      resourceId - Resource ID, to retrieve for the specified resource id. this is an optional field if not passed all the resources will be retrieved for the balance group.
      endDate - End Date, to retrieve the balance groups till the valid to date. this is an optional field if not passed all the resources will be retrieved for the balance group.
      Returns:
      Balance Group Object with limits details