ddAutoCheckout

ddAutoCheckout( 
l_ddIds 
[ g_isBatch( { t | nil } ) ] 
)
=> l_list 

Description

Checks out an object or list of objects automatically. Objects in a temporary directory cannot be managed; this function skips objects that exist only in the library’s temporary directory and displays a warning for them.

Arguments

l_ddIds	A ddId for a single object or a list of ddIds, which are the objects that should be checked out, if necessary. These objects can be a cellview ID, a file within a cellview ID, or a file at either the library or cell level. The files can be from more than one library.
g_isBatch	The batch override. Set to TRUE if the application wants to force being treated as a batch application irrespective of whether there is a registered UI or not. Can be set to FALSE by virtually all applications. It will be used by the SKILL “~>” operator in the case of setting a propBag parameter in a bag that has not been checked out.

Value Returned

l_list

A list of elements, all being t or nil, corresponding to each ID being checked out. The matching index will be set to TRUE if the checkout was done successfully or if none was needed. The matching index will be set to FALSE if either the checkout failed or a checkout was needed but the user refused to do it via the registered UI.

ddAutoCheckout prints a message if a checkout was performed stating what was checked out. ddAutoCheckout generates a warning if a file needed to be checked out but could not be. ddAutoCheckout does not give a message at all if either the user aborted the checkout via the UI or no checkout was needed.

ddAutoCheckout automatically prompts for all checkouts if a registered UI is in place, a specified file requires checkout, and the CDS_PROMPT_CKOUT flag has been set.

Additional Information

The PreAutoCheckout trigger is a pre-trigger invoked to allow preparation of the user environment. It is invoked each time any object is accessed.

To register a trigger to be called by ddAutoCheckout whenever checkouts are requested for an object, use the following code:

ddRegTrigger( "PreAutoCheckout" ’exampleAutoCheckoutTrigger )

where exampleAutoCheckoutTrigger is the SKILL function that the user implements to perform the desired PreAutoCheckout operations.

The PreAutoCheckout trigger is called with the following argument: l_ddId which is a list of the ddIds associated with the files that are being checked out.

The PreAutoCheckout trigger must return a Boolean value. If the return from the trigger is nil, the associated ddAutoCheckout function is canceled.

The ddAutoCheckout function supports triggers. PreAutoCheckout is a trigger. The DDPI invokes the ddAutoCheckout pre-trigger in this order:

• Verifies that the ddAutoCheckout request includes at least one file to check out and returns nil if there are any initialization problems
• Verifies that the user has set the CDS_PROMPT_CKOUT flag
• Verifies that the requested files for membership are in a co-managed set. If you request a checkout of a member of a co-managed set (for example, a view file), the ddId of the requested file is replaced with the ddId of its parent object (for example, the ddId of the view)
• Calls the ddAutoCheckout pre-trigger
• Verifies if the checkout is needed for each ddId
• Executes the prompt as requested for each ddId
• Performs the checkout if needed for each ddId
• Returns an array of boolean values, matching the ddId of the objects passed in, showing TRUE if the object was successfully checked out, or did not need to be checked out, and FALSE if the checkout failed, or the user indicated no desire for checkout.

Related Topics

ddAutoCheckout

Return to top