Bric::Biz::Asset::Formatting - Template assets

$LastChangedRevision$

$LastChangedDate: 2005-08-23 16:23:46 -0700 (Tue, 23 Aug 2005) $

 # Creation of Objects
 $fa = Bric::Biz::Asset::Formatting->new( $init )
 $fa = Bric::Biz::Asset::Formatting->lookup( { id => $id })
 ($fa_list || @fas) = Bric::Biz::Asset::Formatting->list( $param )
 ($faid_list || @fa_ids) = Bric::Biz::Asset::Formatting->list_ids( $param )

 # get / set the data that is contained with in
 $fa = $fa->set_data()
 $data = $fa->get_data()

 # get the file name that this will be deployed to
 $file_name = $fa->get_file_name()

 # get / set the date that this will activate
 $date = $fa->get_deploy_date()
 $fa = $fa->set_deploy_date($date)

 # get the output channel that this is associated with
 $output_channel_id = $fa->get_output_channel__id()

 # get the asset type that this is associated with
 $element__id = $fa->get_element__id()

 # get the category that this is associated with
 $category_id = $fa->get_category_id()

 # Methods Inheriated from Bric::Biz::Asset

 # Class Methods
 $key_name = Bric::Biz::Asset->key_name()
 %priorities = Bric::Biz::Asset->list_priorities()
 $data = Bric::Biz::Asset->my_meths

 # looking up of objects
 ($asset_list || @assets) = Bric::Biz::Asset->list( $param )

 # General information
 $asset       = $asset->get_id()
 $asset       = $asset->set_name($name)
 $name        = $asset->get_name()
 $asset       = $asset->set_description($description)
 $description = $asset->get_description()
 $priority    = $asset->get_priority()
 $asset       = $asset->set_priority($priority)

 # User information
 $usr_id      = $asset->get_user__id()
 $modifier    = $asset->get_modifier()

 # Version information
 $vers        = $asset->get_version();
 $vers_id     = $asset->get_version_id();
 $current     = $asset->get_current_version();
 $checked_out = $asset->get_checked_out()

 # Expire Data Information
 $asset       = $asset->set_expire_date($date)
 $expire_date = $asset->get_expire_date()

 # Desk information
 $desk        = $asset->get_current_desk;
 $asset       = $asset->set_current_desk($desk);

 # Workflow methods.
 $id    = $asset->get_workflow_id;
 $obj   = $asset->get_workflow_object;
 $asset = $asset->set_workflow_id($id);

 # Access note information
 $asset                 = $asset->add_note($note)
 ($note_list || @notes) = $asset->get_notes()

 # Access active status
 $asset            = $asset->deactivate()
 $asset            = $asset->activate()
 ($asset || undef) = $asset->is_active()

 $asset = $asset->save()

 # returns all the groups this is a member of
 ($grps || @grps) = $asset->get_grp_ids()

This has changed, it will need to be updated in a bit

Constructs a new template. Supported Keys:

*

description

*

data

*

deploy_date

*

expire_date

*

workflow_id

*

output_channel - Required unless output channel id passed

*

output_channel__id - Required unless output channel object passed

*

tplate_type - The type of template it is.

*

name - The name of the template. Only used if tplate_type is set to UTILITY_TEMPLATE.

*

element - the at object

*

element__id - the id of the asset type

*

category - the category object

*

category__id - the category id

*

file_type - the type of the template file - this will be used as the extension for the file_name derived from the element name. Supported file_type values are those returned as the first value in each array reference in the array reference returned by CWBric::Util::Burner->list_file_types. Throws:

*

Missing required output channel parameter.

*

Missing required parameter 'element' or 'element__id'.

*

Invalid file_type parameter.

*

Missing required parameter 'name'

*

Invalid tplate_type parameter.

*

Missing required parameter 'category' or 'category_id'.

*

The template already exists in the output channel. Side Effects: NONE. Notes: NONE. Returns an object that matches the parameters Suported Keys

id

A formatting asset ID.

version

Pass to request a specific version otherwise the most current will be returned. Throws: NONE Side Effects: NONE Notes: Inherited from Bric::Biz::Asset. Returns a list or anonymous array of Bric::Biz::Asset::Formatting objects based on the search parameters passed via an anonymous hash. The supported lookup keys are: Supported Keys:

name

The name of a template. May use CWANY for a list of possible values.

title

Same as CWname.

file_name

The file name of a template. May use CWANY for a list of possible values.

description

Template description. May use CWANY for a list of possible values.

id

The template ID. May use CWANY for a list of possible values.

version

The template version number. May use CWANY for a list of possible values.

version_id

The ID of a version of a template. May use CWANY for a list of possible values.

active

Defaults to true

user_id

If defined will return the versions checked out to the user with this id. Otherwise , unless CWchecked_out is passed, it will return the most current non-checked out versions.

site_id

Returns a list of templates associated with a given site ID. May use CWANY for a list of possible values.

category_id

Returns a list of templates in the category represented by a category ID. May use CWANY for a list of possible values.

deployed_version

Returns the versions of the templates as they were last deployed. The CWchecked_out parameter will be ignored if this parameter is passed a true value.

published_version

An alias for CWdeployed_version.

category_uri

Returns a list of templates with a given category URI. May use CWANY for a list of possible values.

checked_out

Indicates whether to list templates that are checked out or not. If 0, then only non-checked out templates will be returned. If 1, then only checked-out templates will be returned. If all, then the checked_out attributed will be ignored (unless the CWuser__id parameter is passed).

checked_in

If passed a true value, this parameter causes the checked in version of the most current version of the template to be returned. When a template is checked out, there are two instances of the current version: the one checked in last, and the one currently being edited. When the CWchecked_in parameter is a true value, then the instance last checked in is returned, rather than the instance currently checked out. This is useful for users who do not currently have a template checked out and wish to see the template as of the last check in, rather than as currently being worked on in the current checkout. If a template is not currently checked out, this parameter has no effect.

return_versions

Will return all the versions of the given templates

element_id

Returns a list of templates associated with a given element ID. May use CWANY for a list of possible values.

element_key_name

Returns a list of templates associated with an element with the given key name. May use CWANY for a list of possible values.

workflow_id

Return a list of templates in the workflow represented by the workflow ID. May use CWANY for a list of possible values.

desk_id

Returns a list of templates on a desk with the given ID. May use CWANY for a list of possible values.

output_channel_id

Returns a list of templates associated with a given output channel ID. May use CWANY for a list of possible values.

priority

Returns a list of templates associated with a given priority value. May use CWANY for a list of possible values.

deploy_status

Boolean value indicating whether to return deployed or undeployed templates.

deploy_date_start

Returns a list of templates last deployed on or after a given date/time.

deploy_date_end

Returns a list of templates last deployed on or before a given date/time.

expire_date_start

Returns a list of templates with a expire date on or after a given date/time.

expire_date_end

Returns a list of templates with a expire date on or before a given date/time.

grp_id

Returns a list of templates that are members of the group with the specified group ID. May use CWANY for a list of possible values.

active

Boolean indicating whether to return active or inactive templates.

simple

Triggers a single OR search that hits name and file name.

Order

A property name to order by.

OrderDirection

The direction in which to order the records, either ASC for ascending (the default) or DESC for descending.

Limit

A maximum number of objects to return. If not specified, all objects that match the query will be returned.

Offset

The number of objects to skip before listing the remaining objcts or the number of objects specified by CWLimit. Throws: NONE. Side Effects: NONE. Notes: Inherited from Bric::Biz::Asset.

$template->DESTROY

Dummy method to prevent wasting time trying to AUTOLOAD DESTROY.

Returns an unordered list or array reference of template object IDs that match the criteria defined. The criteria are the same as those for the CWlist() method except for CWOrder and CWOrderDirection, which CWlist_ids() ignore. Throws: NONE Side Effects: NONE Notes: Inherited from Bric::Biz::Asset. Returns the key name of this class. Throws: NONE Side Effects: NONE Notes: NONE

$meths = Bric::Biz::Asset::Formatting->my_meths

Returns an anonymous hash of introspection data for this object. If called with a true argument, it will return an ordered list or anonymous array of introspection data. If a second true argument is passed instead of a first, then a list or anonymous array of introspection data will be returned for properties that uniquely identify an object (excluding CWid, which is assumed). Each hash key is the name of a property or attribute of the object. The value for a hash key is another anonymous hash containing the following keys:

name

The name of the property or attribute. Is the same as the hash key when an anonymous hash is returned.

disp

The display name of the property or attribute.

get_meth

A reference to the method that will retrieve the value of the property or attribute.

get_args

An anonymous array of arguments to pass to a call to get_meth in order to retrieve the value of the property or attribute.

set_meth

A reference to the method that will set the value of the property or attribute.

set_args

An anonymous array of arguments to pass to a call to set_meth in order to set the value of the property or attribute.

type

The type of value the property or attribute contains. There are only three types:

short

date

blob

len

If the value is a 'short' value, this hash key contains the length of the field.

search

The property is searchable via the list() and list_ids() methods.

req

The property or attribute is required.

props

An anonymous hash of properties used to display the property or attribute. Possible keys include:

type

The display field type. Possible values are

text

textarea

password

hidden

radio

checkbox

select

length

The Length, in letters, to display a text or password field.

maxlength

The maximum length of the property or value - usually defined by the SQL DDL.

rows

The number of rows to format in a textarea field.

cols

The number of columns to format in a textarea field.

vals

An anonymous hash of key/value pairs representing the values and display names to use in a select list. Throws: NONE. Side Effects: NONE. Notes: NONE. Returns the template type number for a string value as returned by CWget_tplate_type_string(). Throws: NONE. Side Effects: NONE. Notes: NONE. Returns the value of the Bric::Biz::Workflow CWTEMPLATE_WORKFLOW constant.

Sets the deployment date for this template Throws: NONE Side Effects: NONE Notes: NONE Returns the deploy date set upon this template Throws: NONE Side Effects: NONE Notes: NONE Returns the deploy status of the formatting asset Throws: NONE Side Effects: NONE Notes: this will return the deploy date sets the deploy status for this template Throws: NONE Side Effect: NONE Notes: This is really the deploy date Returns the URI for the template. This differs from the file_name in that the latter uses the semantics of your local file system.w Throws: NONE Side Effects: NONE Notes: NONE Returns the file path of this template. Throws: NONE Side Effects: NONE Notes: NONE Return the name of the output channel. Throws: NONE Side Effects: NONE Notes: NONE Return the output channel associated with this Formatting asset. Throws: NONE Side Effects: NONE Notes: NONE Returns a the stringified name of the template type attribute. Throws: NONE. Side Effects: NONE. Notes: NONE. Return the name of the element associated with this object. Throws: NONE Side Effects: NONE Notes: NONE Return the key name of the element associated with this object. Throws: NONE Side Effects: NONE Notes: NONE Return the AssetType object for this formatting asset. Throws: NONE Side Effects: NONE Notes: NONE Sets the category id for this formatting asset Throws:

*

The template already exists in the output channel. Side Effects: NONE Notes: NONE Get the category ID for this formatting asset. Throws: NONE Side Effects: NONE Notes: NONE Returns the category object that has been associated with this formatting asset. Throws: NONE Side Effects: NONE Notes: NONE Returns the path from the category Throws: NONE Side Effects: NONE Notes: NONE Get the category name of the category object associated with this formatting asset. Throws: NONE Side Effects: NONE Notes: NONE Set the main data for the formatting asset. In future incarnations there might be more data points that surround this, but not for now. Throws: NONE Side Effects: NONE Notes: NONE Returns the chunk of text that makes up this template. Throws: NONE Side Effects: NONE Notes: NONE This will create a flag to add a new record to the instance table Throws: NONE Side Effects: NONE Notes: NONE Return whether this is the most current version or not. Throws: NONE Side Effects: NONE Notes: NONE This cancles a checkout. This will delete the record from the database Throws: NONE Side Effects: NONE Notes: NONE This will take an older version and copy its data to this version Throws: NONE Side Effects: NONE Notes: NONE this will update or create a record in the database Throws: NONE Side Effects: NONE Notes: NONE

################################################################################

Returns the output channel object associated with this formatting object Throws: NONE Side Effects: NONE Notes: NONE Returns the asset type object that was associated with this formatting asset. Throws: NONE Side Effects: NONE Notes: NONE Returns the category object that this is associated with Throws: NONE Side Effects: NONE Notes: NONE Returns the attribute object that is associated with this formatting object Throws: NONE Side Effects: NONE Notes: NONE Inserts a row into the formatting table that represents a new formatting Asset. Throws: NONE Side Effects: NONE Notes: NONE Inserts a row associated with an instance of a formatting asset Throws: NONE Side Effects: NONE Notes: NONE Updates the formatting table Throws: NONE Side Effects: NONE Notes: NONE Updates the row related to the instance of the formatting asset Throws: NONE Side Effects: NONE Notes: NONE Removes the row associated with this formatting asset from the database Throws: NONE Side Effects: NONE Notes: NONE Removes the instance specific row from the database Throws: NONE Side Effects: NONE Notes: NONE Builds the file name for a template. If CW$file_type, CW$name, or CW$cat are not passed, they'll be fetched (or for CW$file_type, computed) from CW$self. Throws:

*

The template already exists in the output channel. Side Effects: NONE. Notes: NONE.

Sets the name of the template based on an element association. Throws:

*

Missing required parameter 'element' or 'element__id'. Side Effects: NONE. Notes: NONE. Sets the name of the template as a utility template, based on the CWname parameter. Throws:

*

Missing required parameter 'name'. Side Effects: NONE. Notes: NONE.

NONE

michael soderstrom - miraso@pacbell.net

Bric, Bric::Biz::Asset