RLSMAREA CMP_LOCK LIST

The RLSMAREA CMP_LOCK LIST message lists information about release component locks.

The XML service/scope/message tags and attributes for this message are:

<service name="RLSMAREA">
<scope name="CMP_LOCK">
<message name="LIST">

These tags appear in both requests and replies.

RLSMAREA CMP_LOCK LIST — Request

The following example shows how you might code a request to list component lock information for a release. Data structure details for the tag follow the example.

Example XML — RLSMAREA CMP_LOCK LIST Request

<?xml version="1.0"?>
<service name="RLSMAREA">
    <scope name="CMP_LOCK">
        <message name="LIST">
            <header>
                <subsys>4</subsys>
                <test> </test>
                <product>CMN</product>
            </header>
            <request>
                <release>S4711010</release>
                <lockType>I</lockType>
            </request>
        </message>
    </scope>
</service>

...

RLSMAREA CMP_LOCK LIST <request> Data Structure

Subtag	Use	Occurs	Data Type & Length	Values & Dependencies
<applName>	Optional	0 - 1	String (4), variable	Release application name.
<componentNameMask>	Optional	0 - 1	String (256), variable	Component name or mask.
<componentTypeMask>	Optional	0 - 1	String (3), variable	Component type or mask.
<lockType>	Required	1	String (1)	Component lock type. Values: I = Checkin lock
<release>	Required	1	String (8), variable	Release name.
<releaseArea>	Optional	0 - 1	String (8), variable	Release area name.
<user>	Optional	0 - 1	String (8), variable	User ID of user who has lock on component.

...

RLSMAREA CMP_LOCK LIST — Reply

The XML reply to a RLSMAREA CMP_LOCK LIST request returns zero to many <result> data elements. Each result contains information for a locked component.

The standard <response> data element follows any <result> tags in the reply and indicates the success or failure of the request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher. Because it is the final data element in the XML reply message, the <response> tag serves as an end-of-list marker.

The following example shows what the reply message might look like if no component locks are found. Data structure details for the <result> tag follow the example.

Example XML — RLSMAREA CMP_LOCK LIST Reply

...

<?xml version="1.0"?>
<service name="RLSMAREA">
    <scope name="CMP_LOCK">
        <message name="LIST">
            <response>
                <statusMessage>CMR6504I - No information found for Component locks request.</statusMessage>
                <statusReturnCode>08</statusReturnCode>
                <statusReasonCode>6504</statusReasonCode>
            </response>
        </message>
    </scope>
</service>

...

RLSMAREA CMP_LOCK LIST <result> Data Structure

Subtag	Use	Occurs	Data Type & Length	Values & Dependencies
<applName>	Optional	0 - 1	String (4), variable	Release application name.
<componentName>	Optional	0 - 1	String (256), variable	Component name.
<componentType>	Optional	0 - 1	String (3), variable	Component type.
<lockDate>	Optional	0 - 1	Date, yyyymmdd	Component lock date.
<lockTime>	Optional	0 - 1	Time, hhmmss	Component lock time.
<lockType>	Optional	0 - 1	String (1)	Component lock type. Values: I = Checkin lock
<release>	Optional	0 - 1	String (8), variable	Release name.
<releaseArea>	Optional	0 - 1	String (8), variable	Release area name.
<user>	Optional	0 - 1	String (8), variable	User ID of user who has lock on component.

...