Package com.highdeal.admin.hci

Class AdminParameterModel

java.lang.Object
com.highdeal.admin.hci.AdminParameterModel
All Implemented Interfaces:
XMLMarshallable
public class AdminParameterModel extends Object implements XMLMarshallable
The Java class represents a system parameter in the connected SAP CC system.

Implementation in Your Client Application

Consider the available service operations.

Related Operation Requests

Consider the following service operations dedicated to the administration of SAP CC system parameters:

Additional Information

Consult the SAP CC System Parameter Reference documentation for more information about the system parameters and indicators of SAP Convergent Charging.

See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="adminParameter">
   <xs:complexType>
     <xs:attribute name="name" type="xs:string" use="required"/>
     <xs:attribute name="description" type="xs:string"/>
     <xs:attribute name="optional" type="xs:boolean" default="false" />
     <xs:attribute name="defaultValue" type="xs:string" use="required"/>
     <xs:attribute name="initValue" type="xs:string"/>
     <xs:attribute name="value" type="xs:string"/>
     <xs:attribute name="modifiable" type="xs:boolean" default="false"/>
     <xs:attribute name="target" type="xs:string" use="required"/>
     <xs:attribute name="persistent" type="xs:boolean" default="false"/>
     <xs:attribute name="source" use="required">
        <xs:simpleType>
          <xs:restriction base="xs:string">
              <xs:enumeration value="file"/>
              <xs:enumeration value="database"/>
              <xs:enumeration value="instanceMap"/>
              <xs:enumeration value="indicator"/>
              <xs:enumeration value="system"/>
              <xs:enumeration value="xmlGenerated"/>
          </xs:restriction>
        </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="type" type="xs:string" use="required"/>

   </xs:complexType>
 </xs:element>

  • Field Details

    • PARAMETER_MODEL

      public static final String PARAMETER_MODEL
      The XML tag name of this data model: adminParameter
      See Also:

    • UNSET_VALUE

      public static final String UNSET_VALUE
      Constant for an unset value representation on network
      See Also:

    • UNKNOWN_VALUE

      public static final String UNKNOWN_VALUE
      Constant for an unknown value representation on network
      See Also:

    • HIDDEN_VALUE

      public static final String HIDDEN_VALUE
      Constant for a hidden value representation on network
      See Also:

  • Constructor Details

    • AdminParameterModel

      public AdminParameterModel()
      Default constructor needed for unmarshalling.

    • AdminParameterModel

      public AdminParameterModel(com.highdeal.parameter.Parameter parameter, Object target, boolean persistent, boolean useDefinitionOnly)
      AdminParameterModel constructor.
      Parameters:
      parameter - The parameter to represent over the network
      target - The parameter defined target
      persistent - If the parameter represents a persistent value
      useDefinitionOnly - Only marshall definition properties

  • Method Details

    • setName

      public void setName(String name)
      Set the parameter name.
      Parameters:
      name - The parameter name

    • getName

      public String getName()
      Returns the parameter name.
      Returns:
      The parameter name

    • setDescription

      public void setDescription(String description)
      Sets the parameter description.
      Parameters:
      description - The parameter description

    • getDescription

      public String getDescription()
      Returns the comprehensive description of the SAP CC system parameter.
      Returns:
      The parameter description

    • setValue

      public void setValue(String value)
      Sets the parameter value.
      Parameters:
      value - The parameter value to set

    • getValue

      public String getValue()
      Returns the parameter value.
      Returns:
      The parameter value

    • setDefaultValue

      public void setDefaultValue(String defaultValue)
      Sets the parameter default value.
      Parameters:
      defaultValue - The default value of parameter

    • getDefaultValue

      public String getDefaultValue()
      Returns the parameter default value.
      Returns:
      The parameter default value

    • getInitValue

      public String getInitValue()
      Returns the initialization value of this parameter.
      Returns:
      The initial value of the parameter as string

    • setInitValue

      public void setInitValue(String initValue)
      Sets the initialization value of this parameter.
      Parameters:
      initValue - The initial value of the parameter to set

    • setModifiable

      public void setModifiable(boolean isModifiable)
      Sets the modifiable state of the parameter.
      Parameters:
      isModifiable - The modifiable state of the parameter

    • isModifiable

      public boolean isModifiable()
      Is parameter modifiable?
      Returns:
      true if the parameter is modifiable, false otherwise

    • setOptional

      public void setOptional(boolean optional)
      Sets the optional state of the parameter.
      Parameters:
      optional - The optional state of the parameter

    • isOptional

      public boolean isOptional()
      Is parameter optional?
      Returns:
      true if the parameter is optional, false otherwise

    • getTarget

      public String getTarget()
      Gets the corresponding target.
      Returns:
      The target

    • setTarget

      public void setTarget(String target)
      Sets the corresponding target.
      Parameters:
      target - The target to set

    • setPersistent

      public void setPersistent(boolean persistent)
      Sets the persistent state of the parameter.
      Parameters:
      persistent - The persistent state of the parameter

    • isPersistent

      public boolean isPersistent()
      Is parameter persistent?
      Returns:
      true if the parameter is persistent, false otherwise

    • getSource

      public com.highdeal.parameter.Source getSource()
      Returns the source of this parameter.
      Returns:
      The source of parameter as string

    • setSource

      public void setSource(com.highdeal.parameter.Source source)
      Sets the source of this parameter.
      Parameters:
      source - The source of parameter to set

    • getType

      public String getType()
      Returns the type of this parameter.
      Returns:
      The type of parameter as string

    • setType

      public void setType(String type)
      Sets the type of this parameter.
      Parameters:
      type - The type of parameter to set

    • setAttributes

      public void setAttributes(XMLAttributes atts)
      Sets the operation attributes from the XMLAttributes.
      Specified by:
      setAttributes in interface XMLMarshallable
      Parameters:
      atts - The XMLAttributes containing the data

    • addChild

      public void addChild(String tagName, XMLMarshallable child)
      Adds a child tag to this operation.

      This tag is ignored for this model.

      Specified by:
      addChild in interface XMLMarshallable
      Parameters:
      tagName - The name of the tag
      child - The XMLMarshallable child to add

    • addCharacterData

      public void addCharacterData(String cData)
      Adds string data to this model.

      This data is ignored for this model.

      Specified by:
      addCharacterData in interface XMLMarshallable
      Parameters:
      cData - The character data to add to the operation

    • marshal

      public void marshal(XMLOutputter output)
      Writes the operation XML data to the specified output.
      Specified by:
      marshal in interface XMLMarshallable
      Parameters:
      output - The XMLOutputter to write into