NAME
VERSION
DATE
SYNOPSIS
DESCRIPTION
INTERFACE
NOTES
AUTHOR
SEE ALSO
POD ERRORS

NAME

Bric::Biz::Asset::Business - An object that houses the business Assets

VERSION

$Revision: 1.18.2.4 $

DATE

$Date: 2002/10/09 21:58:03 $

SYNOPSIS

# Constructor
$biz = Bric::Biz::Asset::Business->new($param);
# DB object looukp
$biz = Bric::Biz::Asset::Business->lookup({'id' => $biz_id});

# Getting a list of objects
($biz_asset_list||@biz_assets) = Bric::Biz::Asset::Business->list( $criteria )

# Geting a list of ids
($biz_ids || @biz_ids) = Bric::Biz::Asset::Business->list_ids( $criteria )


## METHODS INHERITED 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 stamp information
($desk_stamp_list || @desk_stamps) = $asset->get_desk_stamps()
$desk_stamp                        = $asset->get_current_desk()
$asset                             = $asset->set_current_desk($desk_stamp)

# 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()

DESCRIPTION

This is the parent class for all the business assets ( i.e. Stories, images etc.)

Assumption here is that all Business assets have rights, publish dates and keywords associated with them.

This class contains all the interfact to these data points

INTERFACE

Constructors

$asset = Bric::Biz::Asset::Business->new( $initial_state )

new will only be called by Bric::Biz::Asset::Business's inherited classes

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$asset = Bric::Biz::Asset::Business->lookup( { id => $id} )

This will die because only the inherited classes will be looked up

Throws:

"Method Not Implemented"

Side Effects:

NONE

Notes:

NONE

($obj_list||@objs) = Bric::Biz::Asset::Business->list( $criteria )

This will return a list or list ref of Business assets that match the given criteria

Supported Keys:

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

Destructors

$self->DESTROY: Dummy method to prevent wasting time trying to AUTOLOAD DESTROY.

Public Class Methods

list ids is not allowed for parent classes

You will have to use list to get all the objects

Throws:

"method not implemented"

Side Effects:

NONE

Notes:

NONE

my $key_name = Bric::Biz::Asset::Business->key_name()

Returns the key name of this class.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

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

(@meths || $meths_aref) = Bric::Biz::Asset::Business->my_meths(TRUE)

Returns an anonymous hash of instrospection data for this object. If called with a true argument, it will return an ordered list or anonymous array of intrspection data. The format for each introspection item introspection is as follows:

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 reprsenting the values and display names to use in a select list.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

Public Instance Methods

$title = $asset->get_title()

Returns the title field for this asset

Throws:

NONE

Side Effects:

NONE

Notes:

title is the same as the name field

$asset = $asset->set_title($title)

sets the title for this asset

Throws:

NONE

Side Effects:

NONE

Notes:

title is the same as the name field

$biz = $biz->set_source__id($s_id)

Sets the source id upon this story

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$source = $biz->get_source__id()

Returns the source id from this business asset

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$at_id = $biz->get_element__id()

Returns the asset type id that this story is associated with

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$story->add_contributor($contrib, $role );

Takes a contributor object or id and their role in the context of this story and associates them

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

($contribs || @contribs) = $story->get_contributors()

Returns a list or list ref of the contributors that have been assigned to this story

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$role = $biz->get_contributor_role($contrib)

Returns the role played by this contributor

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$story = $story->delete_contributors( $contributors )

Recieves a list of contributrs or their ids and deletes them from the story

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$asset = $asset->reorder_contributors(@contributors)

Takes a list of ids and sets the new order upon them

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

get_element_name()

Returns the name of the asset type that this is based on. This is the same as the name of the top level tile.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

(@parts || $parts) = $biz->get_possible_data()

Returns the possible data that can be added to the top level tile of this business asset based upon rules defined in asset type

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

(@containers || $containers) = $biz->get_possible_containers()

Returns the containers that are possible to add to the top level container of this businesss asset

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

Public Instance Methods

$self = $story->set_cover_date($cover_date)

Sets the cover date.

Throws:

Bric::_get() - Problems retrieving fields.
Unable to unpack date.
Unable to format date.
Incorrect number of args to Bric::_set().
Bric::set() - Problems setting fields.

Side Effects:

NONE

Notes:

NONE

my $cover_date = $story->get_cover_date($format)

Returns cover date.

Throws:

Bric::_get() - Problems retrieving fields.
Unable to unpack date.
Unable to format date.

Side Effects:

NONE

Notes:

NONE

$self = $story->set_publish_date($publish_date)

Sets the publish date.

Throws:

Bric::_get() - Problems retrieving fields.
Unable to unpack date.
Unable to format date.
Incorrect number of args to Bric::_set().
Bric::set() - Problems setting fields.

Side Effects:

NONE

Notes:

NONE
my $publish_date = $story->get_publish_date($format)

Returns publish date.

Throws:
- Bric::_get() - Problems retrieving fields.
- Unable to unpack date.
- Unable to format date.
Side Effects: NONE.

Notes: NONE.
(@objs || $objs) = $asset->get_related_objects

Return all the related story or media objects for this business asset.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE
$container_tile = $ba->get_tile()

Returns the top level tile that coresponds to this Asset

Throws:

NONE

Side Effects:

NONE

Notes:

NONE
$uri = $biz->get_primary_uri()

Returns the primary URL for this business asset. The primary URL is determined by the pre- and post- directory strings of the primary output channel, the URI of the business object's asset type, and the cover date if the asset type is not a fixed URL.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.
($tiles || @tiles) = $biz->get_tiles()

Returns the tiles that are held with in the top level tile of this business asset. Convenience shortcut to $ba->get_tile->get_tiles.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE
$ba = $ba->add_data( $atd_obj, $data )

This will create a tile and add it to the container. Convenience shortcut to $ba->get_tile->add_data.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE
$new_container = $ba->add_container( $atc_obj )

This will create and return a new container tile that is added to the current container. Convenience shortcut to $ba->get_tile->add_container.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE
$data = $ba->get_data( $name, $obj_order )
$data = $ba->get_data( $name, $obj_order, $format )

Returns the data of a given name and object order. Convenience shortcut to $ba->get_tile->get_data.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE
$container = $ba->get_container( $name, $obj_order )

Returns a container object of the given name that falls at the given object order position. Convenience shortcut to $ba->get_tile->get_container.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE
$asset = $asset->add_keywords(\@keywords)

Adds the given keywords to the asset. Accepts keyword objects or keyword object ids.

Throws: NONE

Side Effects: NONE

Notes: NONE
$kw_aref || @kws = $asset->get_keywords()

Returns an array ref or an array of keyword objects, assigned to this Business Asset.

Throws: NONE

Side Effects: NONE

Notes: NONE
$kw_aref || @kws = $asset->get_all_keywords()

Returns an array ref or an array of keyword objects assigned to this Business Asset and to its categories.

Throws: NONE

Side Effects: NONE

Notes: NONE
$asset = $asset->delete_keywords([$kw]);

Takes a list of keywords and disassociates them from the object. Category keywords can not be disassociated from the asset.

Throws: NONE

Side Effects: NONE

Notes: NONE
($self || undef) = $ba->has_keyword($keyword)

Returns true is the keyword object is associated with this asset.
$self = $self->cancel()

Called upon a checked out asset. This unchecks it out.

Throws:

"Can not cancel a non checked out asset"

Side Effects:

This will remove the coresponding object from the database

Notes:

NONE
($ba || undef) = $ba->is_current()

Return whether this is the most current version or not.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE
= $biz = $biz->checkout( { user__id => $user_id })

checks out the asset to the specified user

Throws:

NONE

Side Effects:

NONE

Notes:

NONE
$ba = $ba->save()

Commits the changes to the database

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

PRIVATE

Private Class Methods

$self = $self->_init()

Preforms functions needed to create new business assets

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

Private Instance Methods

$at_obj = $self->_construct_uri()

Returns URI contructed from the output chanel paths, categories and the date.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$at_obj = $self->_get_element_object()

Returns the asset tpe object that coresponds to this business object

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$self = $self->_sync_contributors()

Syncs the contributors for this story

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$cat_keywords = $ba->_get_category_keywords();

Returns the keywords that are associated with the categories that this asset is associated with

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

Private Functions

NOTES

AUTHOR

michael soderstrom - miraso@pacbell.net

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 307:

You forgot a '=back' before '=head2'

Around line 309:

'=item' outside of any '=over'

Around line 325:

You forgot a '=back' before '=head2'

Around line 452:

Expected '=item *'

Around line 454:

Expected '=item *'

Around line 456:

Expected '=item *'

Around line 458:

Expected '=item *'

Around line 460:

Expected '=item *'

Around line 462:

Expected '=item *'

Around line 464:

Expected '=item *'

Around line 561:

'=item' outside of any '=over'

Around line 993:

You forgot a '=back' before '=head2'

Around line 1119:

Expected '=item *'

Around line 1151:

Expected '=item *'

Around line 1200:

Expected '=item *'

Around line 1233:

Expected '=item *'

Around line 1261:

Expected '=item *'

Around line 1287:

Expected '=item *'

Around line 1313:

Expected '=item *'

Around line 1339:

Expected '=item *'

Around line 1341:

Expected '=item *'

Around line 1367:

Expected '=item *'

Around line 1393:

Expected '=item *'

Around line 1431:

Expected '=item *'

Around line 1451:

Expected '=item *'

Around line 1475:

Expected '=item *'

Around line 1513:

Expected '=item *'

Around line 1529:

Expected '=item *'

Around line 1565:

Expected '=item *'

Around line 1592:

Expected '=item *'

Around line 1652:

Expected '=item *'

Around line 1703:

You forgot a '=back' before '=head2'

Around line 1713:

'=item' outside of any '=over'

Around line 1787:

You forgot a '=back' before '=head2'

Around line 1793:

'=item' outside of any '=over'

Around line 2008:

You forgot a '=back' before '=head2'

NAME

VERSION

DATE

SYNOPSIS

DESCRIPTION

INTERFACE

Constructors

Destructors

Public Class Methods

Public Instance Methods

Public Instance Methods

PRIVATE

Private Class Methods

Private Instance Methods

Private Functions

NOTES

AUTHOR

SEE ALSO

POD ERRORS