com.ados.hestia.parser.rnbm.exchange
Class ServiceContent

java.lang.Object
  extended by com.ados.hestia.parser.rnbm.particle.Common
      extended by com.ados.hestia.parser.rnbm.exchange.ServiceContent
All Implemented Interfaces:
Serializable

public class ServiceContent
extends com.ados.hestia.parser.rnbm.particle.Common

This is standard class to access ServiceContent fields.

Version:
$Revision: 1459 $
See Also:
Serialized Form

Field Summary
protected static String[] FROM_SUBPATH
           
protected static String GLOBAL_FC
           
protected  String m_fullVer
           
protected  String m_originalXML
           
protected  String m_pipID
           
protected  boolean m_production
           
protected  String m_shortVer
           
protected static String THIS_DOC_ID_XSD_STANDARD
           
protected static String THIS_DOC_ID_XSD_VERSION
           
protected static String[] THIS_DOC_IDS
           
protected static String THIS_DOC_TIME
           
protected static String THIS_DOC_TIME_CIDX
           
protected static String THIS_DOC_TIME_CIDX_ATTR
           
protected static String THIS_DOC_TIME_XSD
           
protected static String[] THIS_DOC_TIMES
           
protected static String[] TO_SUBPATH
           
 
Fields inherited from class com.ados.hestia.parser.rnbm.particle.Common
m_element
 
Constructor Summary
ServiceContent()
          For internal use only.
ServiceContent(String pipID, com.ados.hestia.parser.rnbm.model.RootElement element)
           
ServiceContent(String pipID, com.ados.hestia.parser.rnbm.model.RootElement element, String versionFull, String versionShort)
           
ServiceContent(String pipID, com.ados.hestia.parser.rnbm.model.RootElement element, com.ados.hestia.parser.rnbm.Version version)
           
 
Method Summary
 void clear()
          Clear content of document.
 com.ados.hestia.parser.rnbm.particle.DateTimeStamp getDocumentGenerationDateTime()
          Return date of generation of this document.
 String getDocumentIdentifier()
          Return identificator of this document.
 com.ados.hestia.parser.rnbm.particle.PartnerRoleIdentification getFromRole()
          Return description of from role
 String getFullVersion()
          Return full version of PIP which this content is represent.
 String getGlobalDocumentFunctionCode()
          Return type of document "Request", "Response" or null if not present.
 String getName()
          Return name of root element.
 String getOriginalXML()
          Return content of original XML or null if XML was not set.
 String getPIPID()
          Return identificator of PIP.
 com.ados.hestia.parser.rnbm.particle.PartnerRoleIdentification getToRole()
          Return description of to role
 String getVersion()
          Return short version of PIP which this content is represent.
 boolean isProduction()
          Indicate that this content is for test exchange
 boolean isRequest()
          Return true if this document represent Request.
 void setDocumentGenerationDateTime(com.ados.hestia.parser.rnbm.particle.DateTimeStamp dateTime)
          Set date of generation of this document
 void setDocumentIdentifier(String id)
          Set this document identificator.
 void setFromRole(PartnerProfile from, com.ados.hestia.parser.rnbm.repository.PIPBluePrint bp)
          Set "from" role partner description
 void setFromRole(PartnerProfile from, String role)
          Set "from" role partner description
 void setGlobalDocumentFunctionCode(String code)
          Set type of document "Request", "Response".
 void setOriginalXML(String originalXML)
          Set original XML text
 void setProduction(boolean production)
          Set type for this content
 void setToRole(PartnerProfile to, com.ados.hestia.parser.rnbm.repository.PIPBluePrint bp)
          Set "to" role partner description
 void setToRole(PartnerProfile to, String role)
          Set "to" role partner description
 void writeXML(Writer writer, boolean writeFormatted, boolean writeDefNamespace)
          Write content of ServiceContent as XML file
 
Methods inherited from class com.ados.hestia.parser.rnbm.particle.Common
createElement, createElementSafe, deleteElement, deleteElementSafe, getElement, getElement, getElementSafe, getElementValue, getElementValueSafe, getProcessor, setElementValue, setElementValueSafe, validate, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_pipID

protected String m_pipID

m_fullVer

protected String m_fullVer

m_shortVer

protected String m_shortVer

m_production

protected boolean m_production

m_originalXML

protected String m_originalXML

FROM_SUBPATH

protected static final String[] FROM_SUBPATH

TO_SUBPATH

protected static final String[] TO_SUBPATH

THIS_DOC_TIME

protected static final String THIS_DOC_TIME
See Also:
Constant Field Values

THIS_DOC_TIME_XSD

protected static final String THIS_DOC_TIME_XSD
See Also:
Constant Field Values

THIS_DOC_TIME_CIDX

protected static final String THIS_DOC_TIME_CIDX
See Also:
Constant Field Values

THIS_DOC_TIME_CIDX_ATTR

protected static final String THIS_DOC_TIME_CIDX_ATTR
See Also:
Constant Field Values

THIS_DOC_TIMES

protected static final String[] THIS_DOC_TIMES

THIS_DOC_IDS

protected static final String[] THIS_DOC_IDS

THIS_DOC_ID_XSD_STANDARD

protected static final String THIS_DOC_ID_XSD_STANDARD
See Also:
Constant Field Values

THIS_DOC_ID_XSD_VERSION

protected static final String THIS_DOC_ID_XSD_VERSION
See Also:
Constant Field Values

GLOBAL_FC

protected static final String GLOBAL_FC
See Also:
Constant Field Values
Constructor Detail

ServiceContent

public ServiceContent()
For internal use only. Used by test framework.


ServiceContent

public ServiceContent(String pipID,
                      com.ados.hestia.parser.rnbm.model.RootElement element)

ServiceContent

public ServiceContent(String pipID,
                      com.ados.hestia.parser.rnbm.model.RootElement element,
                      com.ados.hestia.parser.rnbm.Version version)

ServiceContent

public ServiceContent(String pipID,
                      com.ados.hestia.parser.rnbm.model.RootElement element,
                      String versionFull,
                      String versionShort)
Method Detail

setOriginalXML

public void setOriginalXML(String originalXML)
Set original XML text

Parameters:
originalXML - - content of original XML

getOriginalXML

public String getOriginalXML()
Return content of original XML or null if XML was not set.

Returns:
content of original XML or null if XML was not set.

writeXML

public void writeXML(Writer writer,
                     boolean writeFormatted,
                     boolean writeDefNamespace)
              throws IOException
Write content of ServiceContent as XML file

Parameters:
writer - writer wich will be filled.
writeFormatted - set to true if formatted output is required.
writeDefNamespace - set to true if fixed namespace must be write.
Throws:
IOException - throws if cannot write to.

getVersion

public String getVersion()
Return short version of PIP which this content is represent.

Returns:
short version of PIP which this content is represent.

getFullVersion

public String getFullVersion()
Return full version of PIP which this content is represent.

Returns:
full version of PIP which this content is represent.

getPIPID

public String getPIPID()
Return identificator of PIP. For example 0C1

Returns:
identificator of PIP. For example 0C1

getName

public String getName()
Return name of root element.

Returns:
name of root element.

getGlobalDocumentFunctionCode

public String getGlobalDocumentFunctionCode()
Return type of document "Request", "Response" or null if not present.

Returns:
return name of root element.

setGlobalDocumentFunctionCode

public void setGlobalDocumentFunctionCode(String code)
Set type of document "Request", "Response".

Parameters:
code - "Request" or "Response".

getDocumentGenerationDateTime

public com.ados.hestia.parser.rnbm.particle.DateTimeStamp getDocumentGenerationDateTime()
Return date of generation of this document.

Returns:
date of generation of this document.

setDocumentGenerationDateTime

public void setDocumentGenerationDateTime(com.ados.hestia.parser.rnbm.particle.DateTimeStamp dateTime)
Set date of generation of this document

Parameters:
dateTime - date of generation of this document

getDocumentIdentifier

public String getDocumentIdentifier()
Return identificator of this document.

Returns:
identificator of this document.

setDocumentIdentifier

public void setDocumentIdentifier(String id)
Set this document identificator.

Parameters:
id - document identificator to set.

isRequest

public boolean isRequest()
Return true if this document represent Request.

Returns:
true if this document represent Request.

clear

public void clear()
Clear content of document.


setFromRole

public void setFromRole(PartnerProfile from,
                        com.ados.hestia.parser.rnbm.repository.PIPBluePrint bp)
Set "from" role partner description

Parameters:
from - specify sender partner
bp - use to extract sender role name

setToRole

public void setToRole(PartnerProfile to,
                      com.ados.hestia.parser.rnbm.repository.PIPBluePrint bp)
Set "to" role partner description

Parameters:
to - specify receiver partner
bp - use to extract receiver role name

setFromRole

public void setFromRole(PartnerProfile from,
                        String role)
Set "from" role partner description

Parameters:
from - specify sender partner
role - specify sender partner role

setToRole

public void setToRole(PartnerProfile to,
                      String role)
Set "to" role partner description

Parameters:
to - specify receiver partner
role - specify receiver partner role

getFromRole

public com.ados.hestia.parser.rnbm.particle.PartnerRoleIdentification getFromRole()
Return description of from role

Returns:
description of from role

getToRole

public com.ados.hestia.parser.rnbm.particle.PartnerRoleIdentification getToRole()
Return description of to role

Returns:
description of to role

isProduction

public boolean isProduction()
Indicate that this content is for test exchange

Returns:
true if this content for production message or true for test

setProduction

public void setProduction(boolean production)
Set type for this content

Parameters:
production - - true if this is for production or false for test


Copyright © 2005-2006 ADOS Co.,Ltd.. All Rights Reserved.