Package oracle.communication.brm.charging.config.servicespec

Interface DomainSpecification

All Known Subinterfaces:
CustomerSpecification, ProductSpecification, RequestSpecification
public interface DomainSpecification
Base interface for all specifications (CustomerSpecification, ProductSpecification or RequestSpecification specifies the common methods.

  • Method Details

    • getName

      String getName()
      gets the name of the Domain Object Specification
      Returns:
      the name of the Domain Object Specification

    • getVersion

      String getVersion()
      gets the version of this Domain Object Specification
      Returns:
      the version as a String.

    • getSpecificationType

      DomainSpecification.DomainSpecificationType getSpecificationType()
      gets the type of the Domain Object Specification
      Returns:
      the Domain Object Specification type

    • getPayloadSpec

      PayloadSpec getPayloadSpec()
      gets the payload spec associated with the supplied operation type.
      Returns:
      the Payload specification for the operation type.

    • getPayloadSpec

      PayloadSpec getPayloadSpec(String opType)
      gets the payload spec associated with the supplied operation type.
      Parameters:
      opType - the operationType whose PayloadSpec is being requested
      Returns:
      the Payload specification for the operation type.

    • getPayloadSpecs

      Set<PayloadSpec> getPayloadSpecs()
      gets a Set of all the PayloadSpecs that are related to the base domain specification
      Returns:
      the PayloadSpecs that describes the domain specification. Will return null if there are none found

    • hasAttribute

      boolean hasAttribute(String attributeName, String opType)
      method used to see if the Domain object specification contains an attribute for the supplied name.
      Parameters:
      attributeName - name of the attribute in question.
      opType - the operationType whose PayloadSpec is being requested
      Returns:
      true if the object specification contains an attribute for the supplied name.

    • getAttributeType

      Class getAttributeType(String attributeName, String opType)
      Method used to get the Type of the attribute.
      Parameters:
      attributeName - name of the attribute in question.
      opType - the operationType whose PayloadSpec is being requested
      Returns:
      the type of the attribute in the specification. Will return null if the type cannot be acquired.

    • getAttributeInfoMap

      Map<String,PayloadAttributeInfo> getAttributeInfoMap()
      This method returns the every payload attribute item name mapped to its detail.
      Returns:
      Map of payload attribute item name to the payload attribute item

    • hasAttributes

      boolean hasAttributes()
      This method returns a boolean flag indicating if the specification contains attributes or not
      Returns:
      true, if there are attributes