MasterCatalog (Oracle Healthcare Data Repository v8.0 API)

All Superinterfaces:: Serializable

public interface MasterCatalog
extends Serializable

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACT_ENTRY_TYPE_CODE` Constant that specifies a `MasterCatalog` entry is of type `Act`.
`static String`	`ANY_CODE_TYPE` Constant that specifies a code type for a `MasterCatalog` entry.
`static String`	`ENTITY_ENTRY_TYPE_CODE` Constant that specifies a `MasterCatalog` entry is of type `Entity`.
`static String`	`ID_CODE_TYPE` Constant that specifies a code type for a `MasterCatalog` entry.
`static String`	`NULL_CODE_TYPE` Constant that specifies a code type for a `MasterCatalog` entry.
`static String`	`PLAYER_OWNER_CODE` Constant that specifies the role owner code.
`static String`	`ROLE_ENTRY_TYPE_CODE` Constant that specifies a `MasterCatalog` entry is of type `Role`.
`static String`	`SCOPER_OWNER_CODE` Constant that specifies the role owner code.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getActiveFlag()` Gets the `ActiveFlag` of this `MasterCatalog`.
`CS`	`getClassCode()` Gets the `ClassCode` of this `MasterCatalog`
`CD`	`getCode()` Gets the `Code` of this `MasterCatalog`
`String`	`getCodeType()` Gets the role of the `code` for this `MasterCatalog` entry.
`SET<CE>`	`getConfidentialityCode()` Gets the `ConfidentialityCode` of this `MasterCatalog`.
`CS`	`getDeterminerCode()` Gets the `DeterminerCode` of this `MasterCatalog`
`String`	`getEntryTypeCode()` Gets the entry type code for this `MasterCatalog`.
`String`	`getMasterCatalogId()` Gets the unique identifier of this `MasterCatalog`.
`CS`	`getMoodCode()` Gets the `MoodCode` of this `MasterCatalog`
`String`	`getPlayerEntityMasterCatalogId()` Gets the `PlayerEntityMasterCatalogId` of this `MasterCatalog`.
`ST`	`getRoleOwnerCode()` Gets the role owner code for this `MasterCatalog`.
`String`	`getScoperEntityMasterCatalogId()` Gets the `ScoperEntityMasterCatalogId` of this `MasterCatalog`.
`void`	`setActiveFlag(boolean activeFlag)` Sets the `ActiveFlag` of this `MasterCatalog`.
`void`	`setClassCode(CS classCode)` Sets the `ClassCode` of this `MasterCatalog`
`void`	`setCode(CD code)` Sets the `Code` of this `MasterCatalog`
`void`	`setCodeType(String codeType)` Sets the role of the `code` for this `MasterCatalog` entry.
`void`	`setConfidentialityCode(SET<CE> confidentialityCode)` Sets the confidentiality codes of this `MasterCatalog`.
`void`	`setDeterminerCode(CS determinerCode)` Gets the `DeterminerCode` of this `MasterCatalog`.
`void`	`setEntryTypeCode(String entryType)` Sets the entry type code for this `MasterCatalog`.
`void`	`setMasterCatalogId(String masterCatalogId)`
`void`	`setMoodCode(CS moodCode)` Sets the `MoodCode` of this `MasterCatalog` entry.
`void`	`setPlayerEntityMasterCatalogId(String playerEntityMasterCatalogId)` Sets the `PlayerEntityMasterCatalogId` of this `MasterCatalog`.
`void`	`setRoleOwnerCode(ST roleOwnerCode)` Gets the role owner code for this `MasterCatalog`.
`void`	`setScoperEntityMasterCatalogId(String scoperEntityMasterCatalogId)` Sets the `ScoperEntityMasterCatalogId` of this `MasterCatalog`.

- Field Detail
  - ACT_ENTRY_TYPE_CODE
```
static final String ACT_ENTRY_TYPE_CODE
```
    Constant that specifies a MasterCatalog entry is of type Act. It is specified when the MasterCatalog entry is created.
    
    See Also:
    
    Constant Field Values
  - ENTITY_ENTRY_TYPE_CODE
```
static final String ENTITY_ENTRY_TYPE_CODE
```
    Constant that specifies a MasterCatalog entry is of type Entity. It is specified when the MasterCatalog entry is created.
    
    See Also:
    
    Constant Field Values
  - ROLE_ENTRY_TYPE_CODE
```
static final String ROLE_ENTRY_TYPE_CODE
```
    Constant that specifies a MasterCatalog entry is of type Role. It is specified when the MasterCatalog entry is created.
    
    See Also:
    
    Constant Field Values
  - ANY_CODE_TYPE
```
static final String ANY_CODE_TYPE
```
    Constant that specifies a code type for a MasterCatalog entry. It is specified when the MasterCatalog entry is created and while creating the entry the code attribute should be null.
    
    See Also:
    
    Constant Field Values
  - ID_CODE_TYPE
```
static final String ID_CODE_TYPE
```
    Constant that specifies a code type for a MasterCatalog entry. It is specified when the MasterCatalog entry is created and while creating the entry the code attribute must be a valid ETS code.
    
    See Also:
    
    Constant Field Values
  - NULL_CODE_TYPE
```
static final String NULL_CODE_TYPE
```
    Constant that specifies a code type for a MasterCatalog entry. It is specified when the MasterCatalog entry is created and while creating the entry the code attribute must be a null.
    
    See Also:
    
    Constant Field Values
  - PLAYER_OWNER_CODE
```
static final String PLAYER_OWNER_CODE
```
    Constant that specifies the role owner code. It is specified when a master catalog entry of type "ROLE" is created.
    
    See Also:
    
    Constant Field Values
  - SCOPER_OWNER_CODE
```
static final String SCOPER_OWNER_CODE
```
    Constant that specifies the role owner code. It is specified when a MasterCatalog entry of type "ROLE" is created.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getMasterCatalogId
```
String getMasterCatalogId()
```
    Gets the unique identifier of this MasterCatalog. This attribute is system generated and cannot be updated.
    
    Returns:
    
    Unique identifier of this MasterCatalog.
    
    System Generated
    
    Internal identifier generated on creation.
    
    Parameter required:
    
    This field is not updatable
    
    Comment:
    
    Represents the unique identifier for this master catalog per installation of HDR.
  - setMasterCatalogId
```
void setMasterCatalogId(String masterCatalogId)
```
  - getClassCode
```
CS getClassCode()
```
    Gets the ClassCode of this MasterCatalog
    
    Returns:
    
    ClassCode of this MasterCatalog.
    
    See Also:
    
    setClassCode(oracle.hsgbu.hdr.hl7.rim.types.CS)
    
    Parameter required:
    
    validated value
    
    This field is not updatable
    
    Comment:
    
    Defines the class code for the MasterCatalog entry, it is validated as a membership code in the CL_ACT_CLASS_CODE, CL_ROL_CLASS_CODE and CL_ENT_CLASS_CODE concept lists.
  - setClassCode
```
void setClassCode(CS classCode)
```
    Sets the ClassCode of this MasterCatalog
    
    Parameters:
    
    classCode - of this MasterCatalog.
    
    See Also:
    
    getClassCode()
    
    Parameter required:
    
    This field is not updatable
  - getMoodCode
```
CS getMoodCode()
```
    Gets the MoodCode of this MasterCatalog
    
    Returns:
    
    MoodCode of this MasterCatalog.
    
    See Also:
    
    setMoodCode(oracle.hsgbu.hdr.hl7.rim.types.CS)
    
    This field is not updatable
    
    Comment:
    
    Defines the mood code for this MasterCatalog entry. Validated as a membership code in the CL_ACT_MOOD_CODE concept list. Required only if the getEntryTypeCode is ACT_ENTRY_TYPE_CODE.
  - setMoodCode
```
void setMoodCode(CS moodCode)
```
    Sets the MoodCode of this MasterCatalog entry. Required only if the getEntryTypeCode is a ACT_ENTRY_TYPE_CODE
    
    Parameters:
    
    moodCode - of this MasterCatalog.
    
    See Also:
    
    getMoodCode()
    
    This field is not updatable
  - getCode
```
CD getCode()
```
    Gets the Code of this MasterCatalog
    
    Returns:
    
    Code of this MasterCatalog.
    
    See Also:
    
    setCode(oracle.hsgbu.hdr.hl7.rim.types.CD)
    
    This field is not updatable
    
    Comment:
    
    If the codeType is ID, then the code has to have a corresponding valid ETS ID.
  - setCode
```
void setCode(CD code)
```
    Sets the Code of this MasterCatalog
    
    Parameters:
    
    code - of this MasterCatalog.
    
    See Also:
    
    getCode()
    
    This field is not updatable
    
    Comment:
    
    If the codeType is ID, then the code has to have a corresponding valid ETS ID.
  - getCodeType
```
String getCodeType()
```
    Gets the role of the code for this MasterCatalog entry. This attribute can take on any of the values defined by the following constants:
    Returns:
    
    Constant describing type of the code. It can take on any of the values defined by the following constants: MasterCatalog.ID_CODE_TYPE, MasterCatalog.ANY_CODE_TYPE, MasterCatalog.NULL_CODE_TYPE.
    
    See Also:
    
    setCodeType(java.lang.String)
    
    Parameter required:
    
    validated value
    
    This field is not updatable
    
    Comment:
    
    Describes the usage of the code for this MasterCatalog entry. Valid values can be MasterCatalog.ANY_CODE_TYPE, MasterCatalog.ID_CODE_TYPE and MasterCatalog.NULL_CODE_TYPE.
  - setCodeType
```
void setCodeType(String codeType)
```
    Sets the role of the code for this MasterCatalog entry. This attribute can take on any of the values defined by the following constants:
    Parameters:
    
    codeType - Code Type value
    
    See Also:
    
    getCodeType()
    
    Parameter required:
    
    validated value
    
    This field is not updatable
    
    Comment:
    
    Describes the usage of the code for this MasterCatalog entry. Valid values can be MasterCatalog.ANY_CODE_TYPE, MasterCatalog.ID_CODE_TYPE and MasterCatalog.NULL_CODE_TYPE.
  - getEntryTypeCode
```
String getEntryTypeCode()
```
    Gets the entry type code for this MasterCatalog. This attribute can take on any of the values defined by the following constants:
    Returns:
    
    Constant describing entry type code for this MasterCatalog. It can take on any of the values defined by the following constants: MasterCatalog.ACT_ENTRY_TYPE_CODE, MasterCatalog.ENTITY_ENTRY_TYPE_CODE, MasterCatalog.ROLE_ENTRY_TYPE_CODE.
    
    See Also:
    
    setEntryTypeCode(java.lang.String)
    
    Parameter required:
    
    This field is not updatable
    
    Comment:
    
    Describes the entry type code for this MasterCatalog entry. Indicates whether this entry is for Act, Role, or Entity.
  - setEntryTypeCode
```
void setEntryTypeCode(String entryType)
```
    Sets the entry type code for this MasterCatalog. This attribute can take on any of the values defined by the following constants:
    Parameters:
    
    entryType - entryType Value
    
    See Also:
    
    getEntryTypeCode()
    
    Parameter required:
    
    This field is not updatable
    
    Comment:
    
    Describes the entry type code for this MasterCatalog entry. Indicates whether this entry is for Act, Role, or Entity.
  - getRoleOwnerCode
```
ST getRoleOwnerCode()
```
    Gets the role owner code for this MasterCatalog. This attribute is relevant only if the getEntryTypeCode() is MasterCatalog.ROLE_ENTRY_TYPE_CODE. Role owner code can take on any of the values defined by the following constants:
    - MasterCatalog.PLAYER_OWNER_CODE
    - MasterCatalog.SCOPER_OWNER_CODE
    Returns:
    
    Constant describing role owner code for this master catalog.. It can take on any of the values defined by the following constants: MasterCatalog.PLAYER_OWNER_CODE, MasterCatalog.SCOPER_OWNER_CODE.
    
    See Also:
    
    setRoleOwnerCode(oracle.hsgbu.hdr.hl7.rim.types.ST)
    
    This field is not updatable
    
    Comment:
    
    Describes the role owner code for this MasterCatalog entry. Relevant only if the getEntryTypeCode() is MasterCatalog.ROLE_ENTRY_TYPE_CODE
  - setRoleOwnerCode
```
void setRoleOwnerCode(ST roleOwnerCode)
```
    Gets the role owner code for this MasterCatalog. It is relevant only if the getEntryTypeCode() is MasterCatalog.ROLE_ENTRY_TYPE_CODE. This attribute can take on any of the values defined by the following constants:
    - MasterCatalog.PLAYER_OWNER_CODE
    - MasterCatalog.SCOPER_OWNER_CODE
    Parameters:
    
    roleOwnerCode - role Owner Code
    
    See Also:
    
    getRoleOwnerCode()
    
    This field is not updatable
    
    Comment:
    
    Describes the role owner code for this MasterCatalog entry. Relevant only if the getEntryTypeCode() is MasterCatalog.ROLE_ENTRY_TYPE_CODE
  - getDeterminerCode
```
CS getDeterminerCode()
```
    Gets the DeterminerCode of this MasterCatalog
    
    Returns:
    
    DeterminerCode of this MasterCatalog.
    
    See Also:
    
    setDeterminerCode(oracle.hsgbu.hdr.hl7.rim.types.CS)
    
    This field is not updatable
    
    Comment:
    
    Defines the determiner code for this MasterCatalog entry. Required only if the getEntryTypeCode is ENTITY_ENTRY_TYPE_CODE.
  - setDeterminerCode
```
void setDeterminerCode(CS determinerCode)
```
    Gets the DeterminerCode of this MasterCatalog.
    
    Parameters:
    
    determinerCode - of this MasterCatalog.
    
    See Also:
    
    setDeterminerCode(oracle.hsgbu.hdr.hl7.rim.types.CS)
    
    This field is not updatable
    
    Comment:
    
    Defines the determiner code for this MasterCatalog entry. Required only if the getEntryTypeCode is ENTITY_ENTRY_TYPE_CODE
  - getPlayerEntityMasterCatalogId
```
String getPlayerEntityMasterCatalogId()
```
    Gets the PlayerEntityMasterCatalogId of this MasterCatalog. This attribute is relevant only if the getEntryTypeCode() is MasterCatalog.ROLE_ENTRY_TYPE_CODE
    
    Returns:
    
    PlayerEntityMasterCatalogId of this MasterCatalog entry.
    
    See Also:
    
    setPlayerEntityMasterCatalogId(java.lang.String)
    
    This field is not updatable
    
    Comment:
    
    Defines the player entity master catalog id for this MasterCatalog entry. Relevant only if the getEntryTypeCode() is MasterCatalog.ROLE_ENTRY_TYPE_CODE
  - setPlayerEntityMasterCatalogId
```
void setPlayerEntityMasterCatalogId(String playerEntityMasterCatalogId)
```
    Sets the PlayerEntityMasterCatalogId of this MasterCatalog. This attribute is relevant only if the getEntryTypeCode() is MasterCatalog.ROLE_ENTRY_TYPE_CODE
    
    Parameters:
    
    playerEntityMasterCatalogId - of this MasterCatalog entry.
    
    See Also:
    
    getPlayerEntityMasterCatalogId()
    
    This field is not updatable
    
    Comment:
    
    Defines the player entity master catalog id for this MasterCatalog entry. Relevant only if the getEntryTypeCode() is MasterCatalog.ROLE_ENTRY_TYPE_CODE
  - getScoperEntityMasterCatalogId
```
String getScoperEntityMasterCatalogId()
```
    Gets the ScoperEntityMasterCatalogId of this MasterCatalog. This attribute is relevant only if the getEntryTypeCode() is MasterCatalog.ROLE_ENTRY_TYPE_CODE
    
    Returns:
    
    ScoperEntityMasterCatalogId of this MasterCatalog entry.
    
    See Also:
    
    setScoperEntityMasterCatalogId(java.lang.String)
    
    This field is not updatable
    
    Comment:
    
    Defines the scoper entity master catalog id for this MasterCatalog entry. Relevant only if the getEntryTypeCode() is MasterCatalog.ROLE_ENTRY_TYPE_CODE
  - setScoperEntityMasterCatalogId
```
void setScoperEntityMasterCatalogId(String scoperEntityMasterCatalogId)
```
    Sets the ScoperEntityMasterCatalogId of this MasterCatalog. This attribute is relevant only if the getEntryTypeCode() is MasterCatalog.ROLE_ENTRY_TYPE_CODE
    
    Parameters:
    
    scoperEntityMasterCatalogId - of this MasterCatalog entry.
    
    See Also:
    
    getScoperEntityMasterCatalogId()
    
    This field is not updatable
    
    Comment:
    
    Defines the scoper entity master catalog id for this MasterCatalog entry. Relevant only if the getEntryTypeCode() is MasterCatalog.ROLE_ENTRY_TYPE_CODE
  - getActiveFlag
```
boolean getActiveFlag()
```
    Gets the ActiveFlag of this MasterCatalog. If not specified, the value of this attribute is set to true.
    
    Returns:
    
    ActiveFlag of this MasterCatalog.
    
    See Also:
    
    setActiveFlag(boolean)
    
    Comment:
    
    Defines the active flag for this MasterCatalog entry. The entry can be deactivated by setting the flag to false.
  - setActiveFlag
```
void setActiveFlag(boolean activeFlag)
```
    Sets the ActiveFlag of this MasterCatalog. If not specified, the value of this attribute is set to true.
    
    Parameters:
    
    activeFlag - of this MasterCatalog.
    
    See Also:
    
    getActiveFlag()
    
    Comment:
    
    Defines the active flag for this MasterCatalog entry. The entry can be deactivated by setting the flag to false.
  - setConfidentialityCode
```
void setConfidentialityCode(SET<CE> confidentialityCode)
```
    Sets the confidentiality codes of this MasterCatalog.
    
    Parameters:
    
    confidentialityCode - that describing all confidentiality levels of this MasterCatalog.
    
    See Also:
    
    getConfidentialityCode()
  - getConfidentialityCode
```
SET<CE> getConfidentialityCode()
```
    Gets the ConfidentialityCode of this MasterCatalog.
    
    Returns:
    
    ConfidentialityCode describing all confidentiality levels of this MasterCatalog.
    
    See Also:
    
    setConfidentialityCode(oracle.hsgbu.hdr.hl7.rim.types.SET<oracle.hsgbu.hdr.hl7.rim.types.CE>)

Interface MasterCatalog

Field Summary

Method Summary

Field Detail

ACT_ENTRY_TYPE_CODE

ENTITY_ENTRY_TYPE_CODE

ROLE_ENTRY_TYPE_CODE

ANY_CODE_TYPE

ID_CODE_TYPE

NULL_CODE_TYPE

PLAYER_OWNER_CODE

SCOPER_OWNER_CODE

Method Detail

getMasterCatalogId

setMasterCatalogId

getClassCode

setClassCode

getMoodCode

setMoodCode

getCode

setCode

getCodeType

setCodeType

getEntryTypeCode

setEntryTypeCode

getRoleOwnerCode

setRoleOwnerCode

getDeterminerCode

setDeterminerCode

getPlayerEntityMasterCatalogId

setPlayerEntityMasterCatalogId

getScoperEntityMasterCatalogId

setScoperEntityMasterCatalogId

getActiveFlag

setActiveFlag

setConfidentialityCode

getConfidentialityCode