SAP CC 3.0 BART API

com.highdeal.bart.hci
Class RunRatingSessionJobModel

java.lang.Object
  extended by com.highdeal.bart.hci.SchedulableJobModel
      extended by com.highdeal.bart.hci.RunRatingSessionJobModel
All Implemented Interfaces:
java.lang.Comparable<SchedulableJobModel>

public class RunRatingSessionJobModel
extends SchedulableJobModel

Run rating session job model is a extends of abstract class SchedulableJobModel.

A run rating session job model is used to launch a rating session periodically.

A run rating session job model is similar to an SchedulableJobModel except for those parameters:


XML Schema Fragment
<xs:element name="runRatingSessionJob">
   <xs:complexType>
     <xs:attribute name="pollingPeriod" type="xs:string"/>
     <xs:attribute name="recurrence" type="xs:string"/>
     <xs:attribute name="batchRatingGroupId" type="xs:string"/>
     <xs:attribute name="mode" type="xs:string"/>
     <xs:attribute name="delay" type="xs:string"/>
     <xs:attribute name="status" type="RunRatingSessionJobStatusType"/>
     <xs:attribute name="description" type="xs:string"/>
     <xs:attribute name="jobID" type="xs:long"/>
   </xs:complexType>
 </xs:element>
<xs:simpleType name="RunRatingSessionJobStatusType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="active"/>
     <xs:enumeration value="inactive"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary
static java.lang.String NAME
          XML tag name of this model.
 
Fields inherited from class com.highdeal.bart.hci.SchedulableJobModel
STATUS_ACTIVE, STATUS_INACTIVE
 
Constructor Summary
RunRatingSessionJobModel()
          Builds an empty job model
RunRatingSessionJobModel(java.lang.Integer batchRatingGroupId, java.lang.Long delay, RatingSessionModel.Mode mode, java.lang.Long pollingPeriod, java.lang.String recurrence, int status, java.lang.String description)
          Public constructor
 
Method Summary
 void addCharacterData(java.lang.String cData)
           
 void addChild(java.lang.String tagName, XMLMarshallable child)
           
 java.lang.Integer getBatchRatingGroupId()
          Gets the batch rating group Id.
 java.lang.Long getDelay()
          Gets the delay compared to system date.
 java.lang.String getJobClassName()
          Gets the class name of this job.
 RatingSessionModel.Mode getMode()
          Gets RatingSessionModel.Mode.
 void marshal(XMLOutputter output)
           
 void setAttributes(XMLAttributes atts)
           
 void setBatchRatingGroupId(java.lang.Integer batchRatingGroupId)
          Sets the batch rating group Id.
 void setDelay(java.lang.Long delay)
          Sets the delay compared to system date.
 void setMode(RatingSessionModel.Mode mode)
          Sets RatingSessionModel.Mode.
 
Methods inherited from class com.highdeal.bart.hci.SchedulableJobModel
_getJobID, _getLastActivationDate, _setJobID, _setLastActivationDate, compareTo, getDescription, getPollingPeriod, getRecurrence, getRecurrenceAsString, getStatus, innerMarshall, innerSetAttributes, parseStatus, setDescription, setPollingPeriod, setRecurrence, setRecurrenceAsString, setStatus, statusToString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NAME

public static final java.lang.String NAME
XML tag name of this model.

See Also:
Constant Field Values
Constructor Detail

RunRatingSessionJobModel

public RunRatingSessionJobModel()
Builds an empty job model


RunRatingSessionJobModel

public RunRatingSessionJobModel(java.lang.Integer batchRatingGroupId,
                                java.lang.Long delay,
                                RatingSessionModel.Mode mode,
                                java.lang.Long pollingPeriod,
                                java.lang.String recurrence,
                                int status,
                                java.lang.String description)
Public constructor

Parameters:
batchRatingGroupId -
delay -
pollingPeriod -
recurrence -
status -
Method Detail

setBatchRatingGroupId

public void setBatchRatingGroupId(java.lang.Integer batchRatingGroupId)
Sets the batch rating group Id.

Parameters:
batchRatingGroupId - the batch rating group Id

getBatchRatingGroupId

public java.lang.Integer getBatchRatingGroupId()
Gets the batch rating group Id.

Returns:
the batch rating group Id.

setDelay

public void setDelay(java.lang.Long delay)
Sets the delay compared to system date.

Parameters:
delay - number of seconds

getDelay

public java.lang.Long getDelay()
Gets the delay compared to system date.

Returns:
the delay compared to system date.

setMode

public void setMode(RatingSessionModel.Mode mode)
Sets RatingSessionModel.Mode.

Parameters:
mode - RatingSessionModel.Mode

getMode

public RatingSessionModel.Mode getMode()
Gets RatingSessionModel.Mode.

Returns:
RatingSessionModel.Mode.

getJobClassName

public java.lang.String getJobClassName()
Gets the class name of this job.

Specified by:
getJobClassName in class SchedulableJobModel
Returns:
the class name of job.

setAttributes

public void setAttributes(XMLAttributes atts)

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

addCharacterData

public void addCharacterData(java.lang.String cData)

marshal

public void marshal(XMLOutputter output)

SAP CC 3.0 BART API

(c) Copyright 2011 SAP AG. All rights reserved. SAP Convergent Charging 3.0