- Publicity: Public Only All
object-procs.tcl
Object support for ACS.
- Location:
- packages/acs-tcl/tcl/object-procs.tcl
- Created:
- 11 Aug 2000
- Author:
- Jon Salz <jsalz@arsdigita.com>
- CVS Identification:
$Id: object-procs.tcl,v 1.16 2024/09/11 06:15:48 gustafn Exp $
Procedures in this file
- acs_magic_object (public)
- acs_object::get (public)
- acs_object::get_element (public)
- acs_object::object_p (public)
- acs_object::package_id (public)
- acs_object::set_context_id (public)
- acs_object_name (public)
- acs_object_type (public)
Detailed information
acs_magic_object (public)
acs_magic_object name
Returns the object ID of a magic object.
- Parameters:
- name (required)
- the name of the magic object (as listed in the
acs_magic_objectstable).- Returns:
- the object ID.
- Error:
- if no object exists with that magic name.
- Testcases:
- magic_objects
acs_object::get (public)
acs_object::get -object_id object_id [ -array array ] \
[ -element element ]Gets information about an acs_object. If called without "-element", it returns a dict containing object_id, package_id, object_type, context_id, security_inherit_p, creation_user, creation_date_ansi, creation_ip, last_modified_ansi, modifying_user, modifying_ip, tree_sortkey, object_name. If called with "-element" it returns the denoted element (similar to e.g. "party::get").
- Switches:
- -object_id (required)
- for which the information should be retrieved
- -array (optional)
- An array in the caller's namespace into which the info should be delivered (upvared)
- -element (optional)
- to be returned
- Error:
- when object_id does not exist
- Testcases:
- acs_object_procs_test
acs_object::get_element (public)
acs_object::get_element -object_id object_id -element element
Gets a specific element from the info returned by acs_object::get.
- Switches:
- -object_id (required)
- the object to get data for
- -element (required)
- the field to return
- Returns:
- the value of the specified element
- See Also:
- Testcases:
- acs_object_procs_test, attachments_name_api
acs_object::object_p (public)
acs_object::object_p -id id
- Switches:
- -id (required)
- ID of the potential acs-object
- Returns:
- true if object whose id is $id exists
- Authors:
- Jim Lynch <jim@jam.sessionsnet.org>
- Malte Sussdorff
- Created:
- 2007-01-26
- Testcases:
- object_p
acs_object::package_id (public)
acs_object::package_id -object_id object_id
Gets the package_id of the object
- Switches:
- -object_id (required)
- the object to get the package_id for
- Returns:
- package_id of the object. Empty string if the package_id is not stored
- Author:
- Malte Sussdorff <malte.sussdorff@cognovis.de>
- Created:
- 2006-08-10
- Testcases:
- acs_object__package_id
acs_object::set_context_id (public)
acs_object::set_context_id -object_id object_id -context_id context_id
Sets the context_id of the specified object.
- Switches:
- -object_id (required)
- -context_id (required)
- Testcases:
- acs_object_procs_test
acs_object_name (public)
acs_object_name object_id
Returns the name of an object.
- Parameters:
- object_id (required)
- Testcases:
- object_name
acs_object_type (public)
acs_object_type object_id
Returns the type of an object.
- Parameters:
- object_id (required)
- Testcases:
- data_links_with_tag, attachments_name_api
