oracle.hsgbu.hdr.hl7.mastercatalog

Interface MasterCatalogService

public interface MasterCatalogService

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVE_FLAG_ALL Used to retrieve those master catalog entries with valid or invalid active flag.
static int	ACTIVE_FLAG_INVALID Used to retrieve those master catalog entries invalid active flag.
static int	ACTIVE_FLAG_VALID Used to retrieve those master catalog entries with valid active flag.
static String	ACTOR_TYPE
static String	ENTITY_TYPE
static String	RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
MasterCatalog[]	findMasterCatalogEntries(MasterCatalogQueryCriteria masterCatalogCriteriaTemplate) Gets the MasterCatalog entries based on MasterCatalogQueryCriteria.
MasterCatalogFocalClassStateTransition	getFocalClassStateTransitionEntry(String controlActMCID, String focalClassActMCID, String startState, String endState) Similar to invoking the method getFocalClassStateTransitionEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalogFocalClassStateTransition	getFocalClassStateTransitionEntry(String controlActMCID, String focalClassActMCID, String startState, String endState, int activeFlagStatus) Queries the MasterCatalogFocalClassStateTransition entries and retrieves the entry matching the control act MasterCatalogId, focal class MasterCatalogId, start state and end state passed as input arguments.
MasterCatalog[]	getMasterCatalogActEntries(boolean activeFlag) Deprecated. use getMasterCatalogActEntries(int activeFlagStatus) if activeFlag is true calls getMasterCatalogActEntries(MasterCatalogService.ACTIVE_FLAG_VALID), if activeFlag is false calls getMasterCatalogActEntries(MasterCatalogService.ACTIVE_FLAG_INVALID)
MasterCatalog[]	getMasterCatalogActEntries(int activeFlagStatus) Retrieves all MasterCatalog entries of type "ACT".
MasterCatalog	getMasterCatalogActEntry(CS class_code, CS mood_code, CD code) Similar to invoking the method getMasterCatalogActEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogActEntry(CS class_code, CS mood_code, CD code, int activeFlagStatus) Queries the MasterCatalog entries of type "ACT" and retrieves the MasterCatalog matching the passed in class_code, mood_code and code.
MasterCatalog	getMasterCatalogActEntry(CS class_code, CS mood_code, CD code, String codeType) Similar to invoking the method getMasterCatalogActEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogActEntry(CS class_code, CS mood_code, CD code, String codeType, int activeFlagStatus) Queries the MasterCatalog entries of type "ACT" and retrieves the MasterCatalog matching the passed in class_code, mood_code,code or its ETS equivalence and codeType.
MasterCatalog	getMasterCatalogActEntry(String class_code, String mood_code, String codeEtsId) Similar to invoking the method getMasterCatalogActEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogActEntry(String class_code, String mood_code, String codeEtsId, int activeFlagStatus) Queries the MasterCatalog entries of type "ACT" and retrieves the MasterCatalog matching the specified class_code, mood_code and codeEtsId.
MasterCatalog	getMasterCatalogActEntry(String class_code, String mood_code, String code, String codeType) Similar to invoking the method getMasterCatalogActEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogActEntry(String class_code, String mood_code, String code, String codeType, int activeFlagStatus) Queries the MasterCatalog entries of type "ACT" and retrieves the MasterCatalog matching the passed in class_code, mood_code,code or its ETS equivalence and codeType.
MasterCatalog[]	getMasterCatalogEntityEntries(int activeFlagStatus) Retrieves all MasterCatalog entries of type "ENTITY".
MasterCatalog	getMasterCatalogEntityEntry(CS class_code, CS determiner_code, CD code) Similar to invoking the method getMasterCatalogEntityEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogEntityEntry(CS class_code, CS determiner_code, CD code, int activeFlagStatus) Queries the MasterCatalog entries of type "ENTITY" and retrieves the MasterCatalog matching the passed in class_code, determiner_code and code.
MasterCatalog	getMasterCatalogEntityEntry(CS class_code, CS determiner_code, CD code, String codeType) Similar to invoking the method getMasterCatalogEntityEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogEntityEntry(CS class_code, CS determiner_code, CD code, String codeType, int activeFlagStatus) Queries the MasterCatalog entries of type "ENTITY" and retrieves the MasterCatalog matching the passed in class_code, determiner_code, code or its ETS equivalence and codeType.
MasterCatalog	getMasterCatalogEntityEntry(String class_code, String determiner_code, String codeEtsId) Similar to invoking the method getMasterCatalogEntityEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogEntityEntry(String class_code, String determiner_code, String codeEtsId, int activeFlagStatus) Queries the MasterCatalog entries of type "ENTITY" and retrieves the MasterCatalog matching the specified class_code, determiner_code and codeEtsId.
MasterCatalog	getMasterCatalogEntityEntry(String class_code, String determiner_code, String code, String codeType) Similar to invoking the method getMasterCatalogEntityEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogEntityEntry(String class_code, String determiner_code, String code, String codeType, int activeFlagStatus) Queries the MasterCatalog entries of type "ENTITY" and retrieves the MasterCatalog matching the passed in class_code, determiner_code, code or its ETS equivalence and codeType.
MasterCatalog	getMasterCatalogEntryById(String mcid) Retrieves MasterCatalog entry given the Mastercatalog ID.
String	getMasterCatalogId(InfrastructureRoot rimObject) Gets the MasterCatalogId that is already set on the supplied RIM object.
MasterCatalog[]	getMasterCatalogRoleEntries(int activeFlagStatus) Retrieves all MasterCatalog entries of type "ROLE".
MasterCatalog	getMasterCatalogRoleEntry(CS class_code, CD code, CS playerClassCode, CS playerDeterminerCode, CD playerCode, CS scoperClassCode, CS scoperDeterminerCode, CD scoperCode, ST owningEntityType) Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogRoleEntry(CS class_code, CD code, CS playerClassCode, CS playerDeterminerCode, CD playerCode, CS scoperClassCode, CS scoperDeterminerCode, CD scoperCode, ST owningEntityType, int activeStatusFlag) Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the passed in class_code, code, playerClassCode, playerDeterminerCode,playerCode, scoperClassCode, scoperDeterminerCode, scoperCode and owningEntitytype.
MasterCatalog	getMasterCatalogRoleEntry(CS class_code, CD code, String codeType, CS playerClassCode, CS playerDeterminerCode, CD playerCode, CS scoperClassCode, CS scoperDeterminerCode, CD scoperCode, ST owningEntityType) Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogRoleEntry(CS class_code, CD code, String codeType, CS playerClassCode, CS playerDeterminerCode, CD playerCode, CS scoperClassCode, CS scoperDeterminerCode, CD scoperCode, ST owningEntityType, int activeStatusFlag) Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the passed in class_code, code or its ETS equivalence,codeType, playerClassCode, playerDeterminerCode,playerCode, scoperClassCode, scoperDeterminerCode, scoperCode and owningEntitytype.
MasterCatalog	getMasterCatalogRoleEntry(CS class_code, CD code, String playerMCID, String scoperMCID, ST owningEntityType) Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogRoleEntry(CS class_code, CD code, String playerMCID, String scoperMCID, ST owningEntityType, int activeStatusFlag) Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the class_code, code, playerMCID, scoperMCID and owningEntitytype.
MasterCatalog	getMasterCatalogRoleEntry(CS class_code, CD code, String codeType, String playerMCID, String scoperMCID, ST owningEntityType) Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogRoleEntry(CS class_code, CD code, String codeType, String playerMCID, String scoperMCID, ST owningEntityType, int activeStatusFlag) Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the class_code, code or its ETS equivalence, codeType, playerMCID, scoperMCID and owningEntitytype.
MasterCatalog	getMasterCatalogRoleEntry(String class_code, String codeEtsId, String playerMCID, String scoperMCID, String owningEntityType) Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogRoleEntry(String class_code, String codeEtsId, String playerMCID, String scoperMCID, String owningEntityType, int activeStatusFlag) Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the passed in class_code, codeEtsId, playerMCID, scoperMCID and owningEntitytype.
MasterCatalog	getMasterCatalogRoleEntry(String class_code, String code, String codeType, String playerMCID, String scoperMCID, String owningEntityType) Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogRoleEntry(String class_code, String code, String codeType, String playerMCID, String scoperMCID, String owningEntityType, int activeStatusFlag) Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the class_code, code or its ETS equivalence, codeType, playerMCID, scoperMCID and owningEntitytype.
MasterCatalog	getMasterCatalogRoleEntry(String class_code, String codeEtsId, String playerClassCode, String playerDeterminerCode, String playerCodeEtsId, String scoperClassCode, String scoperDeterminerCode, String scoperCodeEtsId, String owningEntityType) Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogRoleEntry(String class_code, String codeEtsId, String playerClassCode, String playerDeterminerCode, String playerCodeEtsId, String scoperClassCode, String scoperDeterminerCode, String scoperCodeEtsId, String owningEntityType, int activeStatusFlag) Queries the master catalog entries of type "ROLE" and retrieves the master catalog matching the class_code, code, playerClassCode, playerDeterminerCode,playerCodeEtsId, scoperClassCode, scoperDeterminerCode, scoperCodeEtsId and owningEntitytype.
MasterCatalog	getMasterCatalogRoleEntry(String class_code, String code, String codeType, String playerClassCode, String playerDeterminerCode, String playerCode, String scoperClassCode, String scoperDeterminerCode, String scoperCode, String owningEntityType) Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID
MasterCatalog	getMasterCatalogRoleEntry(String class_code, String code, String codeType, String playerClassCode, String playerDeterminerCode, String playerCode, String scoperClassCode, String scoperDeterminerCode, String scoperCode, String owningEntityType, int activeStatusFlag) Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the passed in class_code, code or its ETS equivalence,codeType, playerClassCode, playerDeterminerCode,playerCode, scoperClassCode, scoperDeterminerCode, scoperCode and owningEntitytype.
String[]	getTriggerEvents(boolean activeFlag) Gets all the trigger events supported by HDR.
String	isFocalClassStateTransitionValid(String controlActMCID, String focalClassActMCID, String startState, String endState) Queries the MasterCatalogFocalClassStateTransition entries and retrieves the trigger event code that matches the control act MasterCatalogId, focal class MasterCatalogId, start state and end state passed as input arguments. If there are multiple matches, the following rules are applied to find the best matching results: Return the entry that exactly matches the start state constraint and end state constraint.
boolean	isGeneralStateTransitionValid(String objectTypeCode, String beginState, String endState) Checks if the state transition start state to end state is valid for the ObjectTypeCode passed as input argument.
boolean	isStateTransitionValid(String mcid, String startState, String endState) Checks if the state transition start state to end state is valid for the MasterCatalogId passed as input argument.
void	persistFocalClassStateTransitionEntries(MasterCatalogFocalClassStateTransition[] MasterCatalogFocalClassStateTransitionTemplates) Creates or updates the specified array of MasterCatalogFocalClassStateTransition entries.
void	persistFocalClassStateTransitionEntry(MasterCatalogFocalClassStateTransition MasterCatalogFocalClassStateTransitionTemplate) Creates or updates the given MasterCatalogFocalClassStateTransition template.
void	persistMasterCatalogEntries(MasterCatalog[] MasterCatalogTemplates) Creates or updates the specified array of MasterCatalog entries.
void	persistMasterCatalogEntry(MasterCatalog MasterCatalogTemplate) Creates or updates the specified MasterCatalog.

Field Detail

ACTIVE_FLAG_VALID

static final int ACTIVE_FLAG_VALID

Used to retrieve those master catalog entries with valid active flag.

See Also:

Constant Field Values

ACTIVE_FLAG_INVALID

static final int ACTIVE_FLAG_INVALID

Used to retrieve those master catalog entries invalid active flag.

See Also:

Constant Field Values

ACTIVE_FLAG_ALL

static final int ACTIVE_FLAG_ALL

Used to retrieve those master catalog entries with valid or invalid active flag.

See Also:

Constant Field Values

RESOURCE_TYPE

static final String RESOURCE_TYPE

See Also:

Constant Field Values

ENTITY_TYPE

static final String ENTITY_TYPE

See Also:

Constant Field Values

ACTOR_TYPE

static final String ACTOR_TYPE

See Also:

Constant Field Values

Method Detail

persistMasterCatalogEntry

void persistMasterCatalogEntry(MasterCatalog MasterCatalogTemplate)
                        throws HDRConfigException

Creates or updates the specified MasterCatalog.

• The mandatory attributes for persisting an entry type code "ACT" are class code, mood code, entry type code and code type.
• The mandatory attributes for persisting an "ENTITY" type are class code, determiner code, entry type code and code type.
• The mandatory attributes for persisting "ROLE" type are class code, entry type code and code type.
  
• If the code type is set to ID_CODE_TYPE then the code attribute in MasterCatalog needs to be non-null and the corresponding EtsId should be valid. This method throws HDRConfigException if the EtsId is null or is invalid. This also throws HDRConfigException if a master catalog entry exists for an equivalent EtsId as they are considered duplicate entry.
• If the code type is set to ANY_CODE_TYPE then the code attribute in MasterCatalog needs to null. This method throws HDRConfigException if the code is non-null.
• If the code type is set to NULL_CODE_TYPE then the code attribute in MasterCatalog needs to be null. This method throws HDRConfigException if the code is non-null.

Parameters:

MasterCatalogTemplate - A template MasterCatalog that contains information that should be used to update an existing or create a new MasterCatalog in HDR.

Throws:

HDRConfigException - Does not throw bundled exception, only the first exception encountered in thrown back.

• If the required data is
  • not filled in
  • invalid
• a duplicate is specified
• an error occurs while creating the MasterCatalog

.

persistMasterCatalogEntries

void persistMasterCatalogEntries(MasterCatalog[] MasterCatalogTemplates)
                          throws HDRConfigException

Creates or updates the specified array of MasterCatalog entries. For each entry in array, it will check if it's a valid entry as follows and persist it. In case of one or more invalid entries it rejects all of them.

• The mandatory attributes for persisting an entry type code "ACT" are class code, mood code, entry type code and code type.
• The mandatory attributes for persisting an "ENTITY" type are class code, determiner code, entry type code and code type.
• The mandatory attributes for persisting "ROLE" type are class code, entry type code and code type.
  
• If the code type is set to ID_CODE_TYPE then the code attribute in MasterCatalog needs to be non-null and the corresponding EtsId should be valid. This method throws HDRConfigException if the EtsId is null or is invalid. This also throws HDRConfigException if a master catalog entry exists for an equivalent EtsId as they are considered duplicate entry.
• If the code type is set to ANY_CODE_TYPE then the code attribute in MasterCatalog needs to null. This method throws HDRConfigException if the code is non-null.
• If the code type is set to NULL_CODE_TYPE then the code attribute in MasterCatalog needs to be null. This method throws HDRConfigException if the code is non-null.

Parameters:

MasterCatalogTemplates - An array of MasterCatalog templates that contains information that should be used to create a new or update an existing MasterCatalog in HDR.

Throws:

HDRConfigException - Only the first exception encountered for each entry in the array is bundled and thrown back.

• If array of MasterCatalog templates is null
• If the required data is
  • not filled in
  • invalid
• a duplicate is specified
• an error occurs while creating the MasterCatalog

.

getMasterCatalogActEntry

MasterCatalog getMasterCatalogActEntry(CS class_code,
                                       CS mood_code,
                                       CD code)
                                throws HDRConfigException

Similar to invoking the method getMasterCatalogActEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint.

mood_code - Mood code constraint.

code - Code constraint.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogActEntry

MasterCatalog getMasterCatalogActEntry(CS class_code,
                                       CS mood_code,
                                       CD code,
                                       int activeFlagStatus)
                                throws HDRConfigException

Queries the MasterCatalog entries of type "ACT" and retrieves the MasterCatalog matching the passed in class_code, mood_code and code. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found.
If the code constraint is null, this method returns a MasterCatalog entry class_code, mood_code and the code type is null. If the code constraint is non-null, this method returns a MasterCatalog entry that matches the specified class_code, mood_code and has code type, "ID" The entry should also match the code's corresponding EtsId or its equivalent value. If the code constraint is non-null and there is no entry that exactly matches the code's corresponding EtsId or its equivalent value, this method returns a MasterCatalog entry that matches the passed in class_code and mood_code and has code type,"ANY".

Parameters:

class_code - Class code constraint.

mood_code - Mood code constraint.

code - Code constraint.

activeFlagStatus - integer representing active status

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogActEntry

MasterCatalog getMasterCatalogActEntry(String class_code,
                                       String mood_code,
                                       String codeEtsId)
                                throws HDRConfigException

Similar to invoking the method getMasterCatalogActEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint

mood_code - Mood code constraint

codeEtsId - EtsId constraint

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - if multiple results are returned.

getMasterCatalogActEntry

MasterCatalog getMasterCatalogActEntry(String class_code,
                                       String mood_code,
                                       String codeEtsId,
                                       int activeFlagStatus)
                                throws HDRConfigException

Queries the MasterCatalog entries of type "ACT" and retrieves the MasterCatalog matching the specified class_code, mood_code and codeEtsId. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. Returns null, if no matching entry is found. If the code constraint is null, this method returns a MasterCatalog entry that matches the specified class_code, mood_code and has code type as "NULL". If the code constraint is non-null, this method returns a MasterCatalog entry that matches the specified class_code, mood_code, codeEtsId or its equivalent value and has code type as "ID". If the code constraint is non-null and there are is no entry that exactly matches the passed in codeEtsId or its equivalent value, this method returns a MasterCatalog entry that matches the specified class_code, mood_code and has code type, "ANY".

Parameters:

class_code - Class code constraint

mood_code - Mood code constraint

codeEtsId - EtsId constraint

activeFlagStatus - integer representing active status

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - if multiple results are returned.

getMasterCatalogActEntry

MasterCatalog getMasterCatalogActEntry(CS class_code,
                                       CS mood_code,
                                       CD code,
                                       String codeType)
                                throws HDRConfigException

Similar to invoking the method getMasterCatalogActEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint.

mood_code - Mood code constraint.

code - Code constraint.

codeType - CodeType constraint.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogActEntry

MasterCatalog getMasterCatalogActEntry(CS class_code,
                                       CS mood_code,
                                       CD code,
                                       String codeType,
                                       int activeFlagStatus)
                                throws HDRConfigException

Queries the MasterCatalog entries of type "ACT" and retrieves the MasterCatalog matching the passed in class_code, mood_code,code or its ETS equivalence and codeType. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found.

Parameters:

class_code - Class code constraint.

mood_code - Mood code constraint.

code - Code constraint.

codeType - CodeType constraint.

activeFlagStatus - integer representing active status

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogActEntry

MasterCatalog getMasterCatalogActEntry(String class_code,
                                       String mood_code,
                                       String code,
                                       String codeType)
                                throws HDRConfigException

Similar to invoking the method getMasterCatalogActEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint.

mood_code - Mood code constraint.

code - Code constraint.

codeType - CodeType constraint.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogActEntry

MasterCatalog getMasterCatalogActEntry(String class_code,
                                       String mood_code,
                                       String code,
                                       String codeType,
                                       int activeFlagStatus)
                                throws HDRConfigException

Queries the MasterCatalog entries of type "ACT" and retrieves the MasterCatalog matching the passed in class_code, mood_code,code or its ETS equivalence and codeType. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found.

Parameters:

class_code - Class code constraint.

mood_code - Mood code constraint.

code - Code constraint.

codeType - CodeType constraint.

activeFlagStatus - integer representing active status

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogActEntries

MasterCatalog[] getMasterCatalogActEntries(boolean activeFlag)
                                    throws HDRConfigException

Deprecated. use getMasterCatalogActEntries(int activeFlagStatus) if activeFlag is true calls getMasterCatalogActEntries(MasterCatalogService.ACTIVE_FLAG_VALID), if activeFlag is false calls getMasterCatalogActEntries(MasterCatalogService.ACTIVE_FLAG_INVALID)

Retrieves all MasterCatalog entries of type "ACT". If the specified activeFlag is set to true, this method returns only those entries of "ACT" type whose active flag is set to true.

Parameters:

activeFlag - Active flag

Returns:

An array of MasterCatalog objects.

Throws:

HDRConfigException

getMasterCatalogActEntries

MasterCatalog[] getMasterCatalogActEntries(int activeFlagStatus)
                                    throws HDRConfigException

Retrieves all MasterCatalog entries of type "ACT". If the specified activeFlagStatus is set to MasterCatalogService.ACTIVE_FLAG_VALID, this method returns only those entries of "ACT" type whose active flag is set to true. If the specified activeFlagStatus is set to MasterCatalogService.ACTIVE_FLAG_INVALID , this method returns only those entries of "ACT" type whose active flag is set to false. If the specified activeFlagStatus is set to MasterCatalogService.ACTIVE_FLAG_ALL, this method returns all entries of "ACT" type regardless of the active flag value.

Parameters:

activeFlagStatus - Active flag status

Returns:

An array of MasterCatalog objects.

Throws:

HDRConfigException

getMasterCatalogRoleEntries

MasterCatalog[] getMasterCatalogRoleEntries(int activeFlagStatus)
                                     throws HDRConfigException

Retrieves all MasterCatalog entries of type "ROLE". If the specified activeFlagStatus is set to MasterCatalogService.ACTIVE_FLAG_VALID, this method returns only those entries of "ROLE" type whose active flag is set to true. If the specified activeFlagStatus is set to MasterCatalogService.ACTIVE_FLAG_INVALID , this method returns only those entries of "ROLE" type whose active flag is set to false. If the specified activeFlagStatus is set to MasterCatalogService.ACTIVE_FLAG_ALL, this method returns all entries of "ROLE" type regardless of the active flag value.

Parameters:

activeFlagStatus - Active flag status

Returns:

An array of MasterCatalog objects.

Throws:

HDRConfigException

getMasterCatalogEntityEntries

MasterCatalog[] getMasterCatalogEntityEntries(int activeFlagStatus)
                                       throws HDRConfigException

Retrieves all MasterCatalog entries of type "ENTITY". If the specified activeFlagStatus is set to MasterCatalogService.ACTIVE_FLAG_VALID, this method returns only those entries of "ENTITY" type whose active flag is set to true. If the specified activeFlagStatus is set to MasterCatalogService.ACTIVE_FLAG_INVALID , this method returns only those entries of "ENTITY" type whose active flag is set to false. If the specified activeFlagStatus is set to MasterCatalogService.ACTIVE_FLAG_ALL, this method returns all entries of "ENTITY" type regardless of the active flag value.

Parameters:

activeFlagStatus - Active flag status

Returns:

An array of MasterCatalog objects.

Throws:

HDRConfigException

getMasterCatalogEntryById

MasterCatalog getMasterCatalogEntryById(String mcid)
                                 throws HDRConfigException

Retrieves MasterCatalog entry given the Mastercatalog ID.

Parameters:

mcid - represents the Mastercatalog ID being searched

Returns:

A MasterCatalog object.

Throws:

HDRConfigException

getMasterCatalogEntityEntry

MasterCatalog getMasterCatalogEntityEntry(CS class_code,
                                          CS determiner_code,
                                          CD code)
                                   throws HDRConfigException

Similar to invoking the method getMasterCatalogEntityEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint

determiner_code - Determiner code constraint

code - Code constraint

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogEntityEntry

MasterCatalog getMasterCatalogEntityEntry(CS class_code,
                                          CS determiner_code,
                                          CD code,
                                          int activeFlagStatus)
                                   throws HDRConfigException

Queries the MasterCatalog entries of type "ENTITY" and retrieves the MasterCatalog matching the passed in class_code, determiner_code and code. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found. If the code constraint is null, this method returns a MasterCatalog entry that matches the specified class_code, determiner_code and code type is null. If the code constraint is non-null, this method returns a MasterCatalog entry that matches the specified class_code, determiner_code and code type, "ID". The entry should also match the code's corresponding EtsId or its equivalent value. If the code constraint is non-null and there is no entry that exactly matches the code's corresponding EtsId or its equivalent value, this method returns a MasterCatalog entry that matches the specified class_code, determiner_code and code type, "ANY".

Parameters:

class_code - Class code constraint

determiner_code - Determiner code constraint

code - Code constraint

activeFlagStatus - Active Flag Status.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogEntityEntry

MasterCatalog getMasterCatalogEntityEntry(CS class_code,
                                          CS determiner_code,
                                          CD code,
                                          String codeType)
                                   throws HDRConfigException

Similar to invoking the method getMasterCatalogEntityEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint

determiner_code - Determiner code constraint

code - Code constraint

codeType - Code constraint

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogEntityEntry

MasterCatalog getMasterCatalogEntityEntry(CS class_code,
                                          CS determiner_code,
                                          CD code,
                                          String codeType,
                                          int activeFlagStatus)
                                   throws HDRConfigException

Queries the MasterCatalog entries of type "ENTITY" and retrieves the MasterCatalog matching the passed in class_code, determiner_code, code or its ETS equivalence and codeType. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found.

Parameters:

class_code - Class code constraint

determiner_code - Determiner code constraint

code - Code constraint

codeType - Code constraint

activeFlagStatus - Active Flag Status.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogEntityEntry

MasterCatalog getMasterCatalogEntityEntry(String class_code,
                                          String determiner_code,
                                          String codeEtsId)
                                   throws HDRConfigException

Similar to invoking the method getMasterCatalogEntityEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint.

determiner_code - Determiner code constraint.

codeEtsId - CodeEtsId constraint.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - if multiple results are returned.

getMasterCatalogEntityEntry

MasterCatalog getMasterCatalogEntityEntry(String class_code,
                                          String determiner_code,
                                          String codeEtsId,
                                          int activeFlagStatus)
                                   throws HDRConfigException

Queries the MasterCatalog entries of type "ENTITY" and retrieves the MasterCatalog matching the specified class_code, determiner_code and codeEtsId. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found. If the code constraint is null, this method returns a MasterCatalog entry that matches the specified class_code, determiner_code and code type is null. If the code constraint is non-null, this method returns a MasterCatalog entry that matches the specified class_code, determiner_code and has code type, "ID". This entry should also match the codeEtsId or its equivalent value. If the code constraint is non-null and there are no entries that exactly match the codeEtsId or its equivalent value, this method returns a MasterCatalog entry that matches the class_code, determiner_code and has code type, "ANY".

Parameters:

class_code - Class code constraint.

determiner_code - Determiner code constraint.

codeEtsId - CodeEtsId constraint.

activeFlagStatus - Active Flag Status.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - if multiple results are returned.

getMasterCatalogEntityEntry

MasterCatalog getMasterCatalogEntityEntry(String class_code,
                                          String determiner_code,
                                          String code,
                                          String codeType)
                                   throws HDRConfigException

Similar to invoking the method getMasterCatalogEntityEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint

determiner_code - Determiner code constraint

code - Code constraint

codeType - Code constraint

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogEntityEntry

MasterCatalog getMasterCatalogEntityEntry(String class_code,
                                          String determiner_code,
                                          String code,
                                          String codeType,
                                          int activeFlagStatus)
                                   throws HDRConfigException

Queries the MasterCatalog entries of type "ENTITY" and retrieves the MasterCatalog matching the passed in class_code, determiner_code, code or its ETS equivalence and codeType. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found.

Parameters:

class_code - Class code constraint

determiner_code - Determiner code constraint

code - Code constraint

codeType - Code constraint

activeFlagStatus - Active Flag Status.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(CS class_code,
                                        CD code,
                                        String playerMCID,
                                        String scoperMCID,
                                        ST owningEntityType)
                                 throws HDRConfigException

Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint

code - Code constraint

playerMCID - Player MasterCatalog id constraint

scoperMCID - Scoper MasterCatalog id constraint

owningEntityType - Owning entity type constraint

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(CS class_code,
                                        CD code,
                                        String playerMCID,
                                        String scoperMCID,
                                        ST owningEntityType,
                                        int activeStatusFlag)
                                 throws HDRConfigException

Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the class_code, code, playerMCID, scoperMCID and owningEntitytype. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found. If the code constraint is null, this method returns a MasterCatalog entry that matches the class_code, playerMCID, scoperMCID, owningEntitytype and the code type is null. If the code constraint is non-null, this method returns a MasterCatalog entry that matches the class_code, playerMCID, scoperMCID,owningEntitytype, and has code type, "ID". This entry should also match the code's corresponding EtsId or its equivalent value. If the code constraint is non-null and there is no entry that exactly matches the code's corresponding EtsId or its equivalent value, this method returns a MasterCatalog entry that matches the class_code, playerMCID, scoperMCID, owningEntitytype, and has code type, "ANY".

Parameters:

class_code - Class code constraint

code - Code constraint

playerMCID - Player MasterCatalog id constraint

scoperMCID - Scoper MasterCatalog id constraint

owningEntityType - Owning entity type constraint

activeStatusFlag - Active Flag Status.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(CS class_code,
                                        CD code,
                                        String codeType,
                                        String playerMCID,
                                        String scoperMCID,
                                        ST owningEntityType)
                                 throws HDRConfigException

Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint

code - Code constraint

codeType - CodeType constraint

playerMCID - Player MasterCatalog id constraint

scoperMCID - Scoper MasterCatalog id constraint

owningEntityType - Owning entity type constraint

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(CS class_code,
                                        CD code,
                                        String codeType,
                                        String playerMCID,
                                        String scoperMCID,
                                        ST owningEntityType,
                                        int activeStatusFlag)
                                 throws HDRConfigException

Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the class_code, code or its ETS equivalence, codeType, playerMCID, scoperMCID and owningEntitytype. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found.

Parameters:

class_code - Class code constraint

code - Code constraint

codeType - CodeType constraint

playerMCID - Player MasterCatalog id constraint

scoperMCID - Scoper MasterCatalog id constraint

owningEntityType - Owning entity type constraint

activeStatusFlag - Active Flag Status.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(String class_code,
                                        String codeEtsId,
                                        String playerMCID,
                                        String scoperMCID,
                                        String owningEntityType)
                                 throws HDRConfigException

Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint

codeEtsId - Code constraint

playerMCID - Player mcid constraint

scoperMCID - Scoper mcid constraint

owningEntityType - Owning entity type constraint

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(String class_code,
                                        String codeEtsId,
                                        String playerMCID,
                                        String scoperMCID,
                                        String owningEntityType,
                                        int activeStatusFlag)
                                 throws HDRConfigException

Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the passed in class_code, codeEtsId, playerMCID, scoperMCID and owningEntitytype. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found. If the code constraint is null, this method returns a MasterCatalog entry that matches the passed in class_code, playerMCID, scoperMCID, owningEntitytype and has code type, null. If the code constraint is non-null,this method returns a MasterCatalog entry that matches the passed in class_code, playerMCID, scoperMCID, owningEntitytype and has code type "ID". This entry should also match the codeEtsId or its equivalent value. If the code constraint is non-null and there is no entry that exactly matches the codeEtsId or its equivalent value, this method returns a MasterCatalog entry class_code, playerMCID, scoperMCID, owningEntitytype and has code type "ANY.

Parameters:

class_code - Class code constraint

codeEtsId - Code constraint

playerMCID - Player mcid constraint

scoperMCID - Scoper mcid constraint

owningEntityType - Owning entity type constraint

activeStatusFlag - Active Flag Status.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(String class_code,
                                        String code,
                                        String codeType,
                                        String playerMCID,
                                        String scoperMCID,
                                        String owningEntityType)
                                 throws HDRConfigException

Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint

code - Code constraint

codeType - CodeType constraint

playerMCID - Player MasterCatalog id constraint

scoperMCID - Scoper MasterCatalog id constraint

owningEntityType - Owning entity type constraint

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(String class_code,
                                        String code,
                                        String codeType,
                                        String playerMCID,
                                        String scoperMCID,
                                        String owningEntityType,
                                        int activeStatusFlag)
                                 throws HDRConfigException

Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the class_code, code or its ETS equivalence, codeType, playerMCID, scoperMCID and owningEntitytype. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found.

Parameters:

class_code - Class code constraint

code - Code constraint

codeType - CodeType constraint

playerMCID - Player MasterCatalog id constraint

scoperMCID - Scoper MasterCatalog id constraint

owningEntityType - Owning entity type constraint

activeStatusFlag - Active Flag Status.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(CS class_code,
                                        CD code,
                                        CS playerClassCode,
                                        CS playerDeterminerCode,
                                        CD playerCode,
                                        CS scoperClassCode,
                                        CS scoperDeterminerCode,
                                        CD scoperCode,
                                        ST owningEntityType)
                                 throws HDRConfigException

Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint

code - Code constraint

playerClassCode - Player class code constraint

playerDeterminerCode - Player determiner code constraint

playerCode - Player Code constraint

scoperClassCode - Scoper class code constraint

scoperDeterminerCode - Scoper determiner code constraint

scoperCode - Scoper Code constraint

owningEntityType - Owning entity type constraint

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(CS class_code,
                                        CD code,
                                        CS playerClassCode,
                                        CS playerDeterminerCode,
                                        CD playerCode,
                                        CS scoperClassCode,
                                        CS scoperDeterminerCode,
                                        CD scoperCode,
                                        ST owningEntityType,
                                        int activeStatusFlag)
                                 throws HDRConfigException

Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the passed in class_code, code, playerClassCode, playerDeterminerCode,playerCode, scoperClassCode, scoperDeterminerCode, scoperCode and owningEntitytype. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found. If the code constraint is null, this method returns a MasterCatalog entry that matches the specified class_code, playerClassCode, playerDeterminerCode,playerCode, scoperClassCode, scoperDeterminerCode, scoperCode, owningEntitytype and code type is null. If the code constraint is non-null, this method returns a MasterCatalog entry that matches the specified class_code, playerClassCode, playerDeterminerCode,playerCode, scoperClassCode, scoperDeterminerCode, scoperCode, owningEntitytype and has code type, "ID". This entry should also match the code's corresponding EtsId or its equivalent value. If the code constraint is non-null and there are is no entry that exactly matches code's corresponding EtsId or its equivalent value, this method returns a MasterCatalog entry that matches the specified class_code, playerClassCode, playerDeterminerCode,playerCode, scoperClassCode, scoperDeterminerCode, scoperCode, owningEntitytype and has code type, "ANY".

Parameters:

class_code - Class code constraint

code - Code constraint

playerClassCode - Player class code constraint

playerDeterminerCode - Player determiner code constraint

playerCode - Player Code constraint

scoperClassCode - Scoper class code constraint

scoperDeterminerCode - Scoper determiner code constraint

scoperCode - Scoper Code constraint

owningEntityType - Owning entity type constraint

activeStatusFlag - Active Flag Status.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(CS class_code,
                                        CD code,
                                        String codeType,
                                        CS playerClassCode,
                                        CS playerDeterminerCode,
                                        CD playerCode,
                                        CS scoperClassCode,
                                        CS scoperDeterminerCode,
                                        CD scoperCode,
                                        ST owningEntityType)
                                 throws HDRConfigException

Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint

code - Code constraint

codeType - CodeType constraint

playerClassCode - Player class code constraint

playerDeterminerCode - Player determiner code constraint

playerCode - Player Code constraint

scoperClassCode - Scoper class code constraint

scoperDeterminerCode - Scoper determiner code constraint

scoperCode - Scoper Code constraint

owningEntityType - Owning entity type constraint

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(CS class_code,
                                        CD code,
                                        String codeType,
                                        CS playerClassCode,
                                        CS playerDeterminerCode,
                                        CD playerCode,
                                        CS scoperClassCode,
                                        CS scoperDeterminerCode,
                                        CD scoperCode,
                                        ST owningEntityType,
                                        int activeStatusFlag)
                                 throws HDRConfigException

Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the passed in class_code, code or its ETS equivalence,codeType, playerClassCode, playerDeterminerCode,playerCode, scoperClassCode, scoperDeterminerCode, scoperCode and owningEntitytype. This method returns null if no matching entry is found. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found.

Parameters:

class_code - Class code constraint

code - Code constraint

codeType - CodeType constraint

playerClassCode - Player class code constraint

playerDeterminerCode - Player determiner code constraint

playerCode - Player Code constraint

scoperClassCode - Scoper class code constraint

scoperDeterminerCode - Scoper determiner code constraint

scoperCode - Scoper Code constraint

owningEntityType - Owning entity type constraint

activeStatusFlag - Active Flag Status.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(String class_code,
                                        String codeEtsId,
                                        String playerClassCode,
                                        String playerDeterminerCode,
                                        String playerCodeEtsId,
                                        String scoperClassCode,
                                        String scoperDeterminerCode,
                                        String scoperCodeEtsId,
                                        String owningEntityType)
                                 throws HDRConfigException

Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint.

codeEtsId - Code constraint.

playerClassCode - Player class code constraint.

playerDeterminerCode - Player determiner code constraint.

playerCodeEtsId - Player code constraint.

scoperClassCode - Scoper class code constraint.

scoperDeterminerCode - Scoper determiner code constraint.

scoperCodeEtsId - Scoper code constraint.

owningEntityType - Owning entity type constraint

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(String class_code,
                                        String codeEtsId,
                                        String playerClassCode,
                                        String playerDeterminerCode,
                                        String playerCodeEtsId,
                                        String scoperClassCode,
                                        String scoperDeterminerCode,
                                        String scoperCodeEtsId,
                                        String owningEntityType,
                                        int activeStatusFlag)
                                 throws HDRConfigException

Queries the master catalog entries of type "ROLE" and retrieves the master catalog matching the class_code, code, playerClassCode, playerDeterminerCode,playerCodeEtsId, scoperClassCode, scoperDeterminerCode, scoperCodeEtsId and owningEntitytype. This method returns null if no matching entry is found. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. If the code constraint is null, this method returns a MasterCatalog entry that matches the passed in class_code, playerClassCode, playerDeterminerCode,playerCodeEtsId, scoperClassCode, scoperDeterminerCode, scoperCodeEtsId, owningEntitytype and code type is null. If the code constraint is non-null, this method returns a MasterCatalog entry that matches the passed in class_code, playerClassCode, playerDeterminerCode,playerCodeEtsId, scoperClassCode, scoperDeterminerCode, scoperCodeEtsId, owningEntitytype, has code type, "ID". This entry should also match the codeEtsId or its equivalent value. If the code constraint is non-null and there is no entry that exactly matches the passed in class_code, playerClassCode, playerDeterminerCode,playerCodeEtsId, scoperClassCode, scoperDeterminerCode, scoperCodeEtsId, owningEntitytype, has code type, "ANY".

Parameters:

class_code - Class code constraint.

codeEtsId - Code constraint.

playerClassCode - Player class code constraint.

playerDeterminerCode - Player determiner code constraint.

playerCodeEtsId - Player code constraint.

scoperClassCode - Scoper class code constraint.

scoperDeterminerCode - Scoper determiner code constraint.

scoperCodeEtsId - Scoper code constraint.

owningEntityType - Owning entity type constraint

activeStatusFlag - Active Flag Status.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(String class_code,
                                        String code,
                                        String codeType,
                                        String playerClassCode,
                                        String playerDeterminerCode,
                                        String playerCode,
                                        String scoperClassCode,
                                        String scoperDeterminerCode,
                                        String scoperCode,
                                        String owningEntityType)
                                 throws HDRConfigException

Similar to invoking the method getMasterCatalogRoleEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

class_code - Class code constraint

code - Code constraint

codeType - CodeType constraint

playerClassCode - Player class code constraint

playerDeterminerCode - Player determiner code constraint

playerCode - Player Code constraint

scoperClassCode - Scoper class code constraint

scoperDeterminerCode - Scoper determiner code constraint

scoperCode - Scoper Code constraint

owningEntityType - Owning entity type constraint

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

getMasterCatalogRoleEntry

MasterCatalog getMasterCatalogRoleEntry(String class_code,
                                        String code,
                                        String codeType,
                                        String playerClassCode,
                                        String playerDeterminerCode,
                                        String playerCode,
                                        String scoperClassCode,
                                        String scoperDeterminerCode,
                                        String scoperCode,
                                        String owningEntityType,
                                        int activeStatusFlag)
                                 throws HDRConfigException

Queries the MasterCatalog entries of type "ROLE" and retrieves the MasterCatalog matching the passed in class_code, code or its ETS equivalence,codeType, playerClassCode, playerDeterminerCode,playerCode, scoperClassCode, scoperDeterminerCode, scoperCode and owningEntitytype. This method returns null if no matching entry is found. If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. This method returns null if no matching entry is found.

Parameters:

class_code - Class code constraint

code - Code constraint

codeType - CodeType constraint

playerClassCode - Player class code constraint

playerDeterminerCode - Player determiner code constraint

playerCode - Player Code constraint

scoperClassCode - Scoper class code constraint

scoperDeterminerCode - Scoper determiner code constraint

scoperCode - Scoper Code constraint

owningEntityType - Owning entity type constraint

activeStatusFlag - Active Flag Status.

Returns:

A MasterCatalog object.

Throws:

HDRConfigException - If multiple results are returned.

persistFocalClassStateTransitionEntry

void persistFocalClassStateTransitionEntry(MasterCatalogFocalClassStateTransition MasterCatalogFocalClassStateTransitionTemplate)
                                    throws HDRConfigException

Creates or updates the given MasterCatalogFocalClassStateTransition template.

• The mandatory attributes for persisting are control act MasterCatalogId, focal class MasterCatalogId, start state and end state.
• The state transition of the focal class specified in MasterCatalogFocalClassStateTransition template is validated against the generic state transition. If the state transition is invalid, HDRConfigException is thrown.

Parameters:

MasterCatalogFocalClassStateTransitionTemplate - A template MasterCatalogFocalClassStateTransition that contains information that should be used to create a new or update an existing MasterCatalogFocalClassStateTransition entry in HDR.

Throws:

HDRConfigException -

• If the required data is
  • not filled in
  • invalid
• a duplicate is specified
• an error occurs while creating the MasterCatalogFocalClassStateTransition

.

persistFocalClassStateTransitionEntries

void persistFocalClassStateTransitionEntries(MasterCatalogFocalClassStateTransition[] MasterCatalogFocalClassStateTransitionTemplates)
                                      throws HDRConfigException

Creates or updates the specified array of MasterCatalogFocalClassStateTransition entries. For each entry in array, it will check if it's a valid entry as follows and persists it. In case of one or more invalid entries it rejects all of them.

• The mandatory attributes for persisting are control act MasterCatalogId, focal class MasterCatalogId, start state and end state.
• The state transition of the focal class specified in MasterCatalogFocalClassStateTransition template is validated against the generic state transition. If the state transition is invalid, HDRConfigException is thrown.

Parameters:

MasterCatalogFocalClassStateTransitionTemplates - An array of MasterCatalogFocalClassStateTransition templates that contains information that should be used to create a new or update an existing MasterCatalogFocalClassStateTransition entry in HDR.

Throws:

HDRConfigException - - bundles all the exceptions

• If array of MasterCatalogFocalClassStateTransition templates is null
• If the required data is
  • not filled in
  • invalid
• a duplicate is specified
• an error occurs while creating the MasterCatalogFocalClassStateTransition

.

getFocalClassStateTransitionEntry

MasterCatalogFocalClassStateTransition getFocalClassStateTransitionEntry(String controlActMCID,
                                                                         String focalClassActMCID,
                                                                         String startState,
                                                                         String endState)
                                                                  throws HDRConfigException

Similar to invoking the method getFocalClassStateTransitionEntry with active flag status set to ACTIVE_FLAG_VALID

Parameters:

controlActMCID - Control act MCID constraint.

focalClassActMCID - Focal class MCID constraint.

startState - Start state constraint.

endState - End state constraint.

Returns:

A MasterCatalogFocalClassStateTransition object.

Throws:

HDRConfigException - If multiple results are returned.

getFocalClassStateTransitionEntry

MasterCatalogFocalClassStateTransition getFocalClassStateTransitionEntry(String controlActMCID,
                                                                         String focalClassActMCID,
                                                                         String startState,
                                                                         String endState,
                                                                         int activeFlagStatus)
                                                                  throws HDRConfigException

Queries the MasterCatalogFocalClassStateTransition entries and retrieves the entry matching the control act MasterCatalogId, focal class MasterCatalogId, start state and end state passed as input arguments. Returns null if no matching entry is found.
If the activeFlagStatus passed in is set to ACTIVE_FLAG_VALID, then only entries with valid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_INVALID, then only entries with invalid active flag is retrieved. If the activeFlagStatus passed in is set to ACTIVE_FLAG_ALL, then all entries with valid or invalid active flag is retrieved. If there are multiple matches the following rules are applied to resolve to find the best matching results:

• Return the entry that exactly matches the start state constraint and end state constraint.
• Return the entry that matches the start state constraint and end state as "ANY".
• Return the entry that matches the start state as "ANY" and end state constraint.
• Return the entry that matches the start state as "ANY" and end state as "ANY".

Parameters:

controlActMCID - Control act MCID constraint.

focalClassActMCID - Focal class MCID constraint.

startState - Start state constraint.

endState - End state constraint.

activeFlagStatus - Active Flag Status.

Returns:

A MasterCatalogFocalClassStateTransition object.

Throws:

HDRConfigException -

• If controlActMCID is null
• If focalClassMCID is null

isFocalClassStateTransitionValid

String isFocalClassStateTransitionValid(String controlActMCID,
                                        String focalClassActMCID,
                                        String startState,
                                        String endState)
                                 throws HDRConfigException

Queries the MasterCatalogFocalClassStateTransition entries and retrieves the trigger event code that matches the control act MasterCatalogId, focal class MasterCatalogId, start state and end state passed as input arguments.
If there are multiple matches, the following rules are applied to find the best matching results:

• Return the entry that exactly matches the start state constraint and end state constraint.
• Return the entry that matches the start state constraint and end state as "ANY".
• Return the entry that matches the start state as "ANY" and end state constraint.
• Return the entry that matches the start state as "ANY" and end state as "ANY".

If focal class state transition is found but no trigger event code is defined for the entry, it returns null. This method is used by RIM persistence to validate the state transition of focal objects. There can be 4 types of focal class state transitions for any RIM object and they are validated as mentioned below.

• null to null : This is always valid, even if there is no focal class state transition defined in MasterCatalog. This method returns null here.
• null to not-null : This will be validated against the focal class state transition defined in MasterCatalog.
• not-null to not-null : This will be validated against the focal class state transition defined in MasterCatalog.
• not-null to null : This is not allowed and will result in exception.

Parameters:

controlActMCID - Control act master catalog ID constraint

focalClassActMCID - Focal class master catalog ID constraint

startState - Start state constraint

endState - End state constraint

Returns:

Trigger event code.

Throws:

HDRConfigException -

• If the focal class state transition is not a valid generic HL7 state transition.
• If the method does not find any entry that matches the constraint.

isStateTransitionValid

boolean isStateTransitionValid(String mcid,
                               String startState,
                               String endState)
                        throws HDRConfigException

Checks if the state transition start state to end state is valid for the MasterCatalogId passed as input argument. This method does not check for ActiveFlag.
The method returns true for the state transition record that shows the state transition valid but is in non-active state. This means that it is possible to find that a state transition is valid using this method, but then find that it fails during persistence as persistence uses isFocalClassStateTransitionValid method to validate state transitions while creating or updating RIM objects.

Parameters:

mcid - MasterCatalogId.

startState - Start state.

endState - End state.

Returns:

true if state transition is valid, else returns false.

Throws:

HDRConfigException

isGeneralStateTransitionValid

boolean isGeneralStateTransitionValid(String objectTypeCode,
                                      String beginState,
                                      String endState)
                               throws HDRConfigException

Checks if the state transition start state to end state is valid for the ObjectTypeCode passed as input argument. This method does not check for ActiveFlag.
The method returns true for the state transition record that shows the state transition valid but is in non-active state. This means that it is possible to find that a state transition is valid using this method, but then find that it fails during persistence as persistence uses isFocalClassStateTransitionValid method to validate state transitions while creating or updating RIM objects.

Parameters:

objectTypeCode - ObjectTypeCode.

beginState - Start state.

endState - End state.

Returns:

true if state transition is valid, else returns false.

Throws:

HDRConfigException

getTriggerEvents

String[] getTriggerEvents(boolean activeFlag)
                   throws HDRConfigException

Gets all the trigger events supported by HDR. If the activeFlag is set to true, this method returns only those entries with activeFlag set to true.

Parameters:

activeFlag - Active flag.

Returns:

Array of trigger events.

Throws:

HDRConfigException

getMasterCatalogId

String getMasterCatalogId(InfrastructureRoot rimObject)
                   throws HDRConfigException

Gets the MasterCatalogId that is already set on the supplied RIM object. This method does not try to derive the MasterCatalogId for the supplied RIM object. This method returns null if the MasterCatalogId is not already set on the RIM object.

Parameters:

rimObject - The RIM object for which the MasterCatalogId has to be found.

Returns:

MasterCatalogId already set on the supplied RIM object

Throws:

HDRConfigException

findMasterCatalogEntries

MasterCatalog[] findMasterCatalogEntries(MasterCatalogQueryCriteria masterCatalogCriteriaTemplate)
                                  throws HDRConfigException,
                                         ETSException

Gets the MasterCatalog entries based on MasterCatalogQueryCriteria.

Parameters:

masterCatalogCriteriaTemplate - Query criteria for MasterCatalog record search

Returns:

array of MasterCatalog objects returned from the search

Throws:

HDRConfigException

ETSException