ca.uhn.hl7v2.model.v24.datatype
Class PIP

java.lang.Object
  ca.uhn.hl7v2.model.AbstractType
      ca.uhn.hl7v2.model.v24.datatype.PIP

All Implemented Interfaces:

Composite, Type, Serializable

public class PIP
extends AbstractType
implements Composite

Represents an HL7 PIP (Privileges) data type. This type consists of the following components:

• privilege (CE)
• privilege class (CE)
• expiration date (DT)
• activation date (DT)
• facility (EI) (EI)

See Also:

Serialized Form

Constructor Summary

PIP(Message message)
Creates a new PIP type

Method Summary

DT	getActivationDate() Returns activation date (component #4).
Type	getComponent(int number) Returns an individual data component.
Type[]	getComponents() Returns an array containing the data elements.
DT	getExpirationDate() Returns expiration date (component #3).
EI	getFacility() Returns facility (EI) (component #5).
CE	getPip1_Privilege() Returns privilege (component #1).
CE	getPip2_PrivilegeClass() Returns privilege class (component #2).
DT	getPip3_ExpirationDate() Returns expiration date (component #3).
DT	getPip4_ActivationDate() Returns activation date (component #4).
EI	getPip5_Facility() Returns facility (EI) (component #5).
CE	getPrivilege() Returns privilege (component #1).
CE	getPrivilegeClass() Returns privilege class (component #2).

Methods inherited from class ca.uhn.hl7v2.model.AbstractType

clear, encode, getExtraComponents, getMessage, getName, parse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.hl7v2.model.Type

clear, encode, getExtraComponents, getMessage, getName, parse

Constructor Detail

PIP

public PIP(Message message)

Creates a new PIP type

Method Detail

getComponents

public Type[] getComponents()

Returns an array containing the data elements.

Specified by:

getComponents in interface Composite

getComponent

public Type getComponent(int number)
                  throws DataTypeException

Returns an individual data component.

Specified by:

getComponent in interface Composite

Parameters:

number - The component number (0-indexed)

Throws:

DataTypeException - if the given element number is out of range.

getPrivilege

public CE getPrivilege()

Returns privilege (component #1). This is a convenience method that saves you from casting and handling an exception.

getPip1_Privilege

public CE getPip1_Privilege()

Returns privilege (component #1). This is a convenience method that saves you from casting and handling an exception.

getPrivilegeClass

public CE getPrivilegeClass()

Returns privilege class (component #2). This is a convenience method that saves you from casting and handling an exception.

getPip2_PrivilegeClass

public CE getPip2_PrivilegeClass()

Returns privilege class (component #2). This is a convenience method that saves you from casting and handling an exception.

getExpirationDate

public DT getExpirationDate()

Returns expiration date (component #3). This is a convenience method that saves you from casting and handling an exception.

getPip3_ExpirationDate

public DT getPip3_ExpirationDate()

Returns expiration date (component #3). This is a convenience method that saves you from casting and handling an exception.

getActivationDate

public DT getActivationDate()

Returns activation date (component #4). This is a convenience method that saves you from casting and handling an exception.

getPip4_ActivationDate

public DT getPip4_ActivationDate()

Returns activation date (component #4). This is a convenience method that saves you from casting and handling an exception.

getFacility

public EI getFacility()

Returns facility (EI) (component #5). This is a convenience method that saves you from casting and handling an exception.

getPip5_Facility

public EI getPip5_Facility()

Returns facility (EI) (component #5). This is a convenience method that saves you from casting and handling an exception.