NAME
VERSION
DATE
SYNOPSIS
DESCRIPTION
INTERFACE
PRIVATE
- Private Class Methods
- Private Instance Methods
NOTES
AUTHOR
SEE ALSO

NAME

Bric::Biz::Asset::Business::Story - The interface to the Story Object

VERSION

$Revision: 1.39.2.27 $

DATE

$Date: 2003/11/25 19:47:56 $

SYNOPSIS

# creation of new objects
$story = Bric::Biz::Asset::Business::Story->new( $init )
$story = Bric::Biz::Asset::Business::Story->lookup( $param )
($stories || @stories) = Bric::Biz::Asset::Business::Story->list($param)

# list of object ids
($ids || @ids) = Bric::Biz::Asset::Business::Story->list_ids($param)


## METHODS INHERITED FROM Bric::Biz::Asset ##

 # General information
$asset       = $asset->get_id()
$asset       = $asset->set_description($description)
$description = $asset->get_description()

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

# Version information
$vers_grp_id = $asset->get_version_grp__id();
$vers_id     = $asset->get_assset_version_id();

# 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;
$id  = $asset->set_workflow_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()

# Publish info
$needs_publish = $asset->needs_publish();

## METHODS INHERITED FROM Bric::Biz::Asset::Business ##

# General info
$name = $biz->get_name()
$biz  = $biz->set_name($name)
$ver  = $biz->get_version()

# AssetType information
$name        = $biz->get_element_name()
$at_id       = $biz->get_element__id()
$biz         = $biz->set_element__id($at_id)

# Tile methods
$container_tile  = $biz->get_tile()
@container_tiles = $biz->get_tiles()
$biz             = $biz->add_data($at_data_obj, $data)
$data            = $biz->get_data($name, $obj_order)
$parts           = $biz->get_possible_data()

# Container methods
$new_container = $biz->add_container($at_contaier_obj)
$container     = $biz->get_container($name, $obj_order)
@containes     = $biz->get_possible_containers()

# Access Categories
$cat             = $biz->get_primary_category;
$biz             = $biz->set_primary_category($cat);
($cats || @cats) = $biz->get_secondary_categories;
$biz             = $biz->add_categories([$category, ...])
($cats || @cats) = $biz->get_categories()
$biz             = $biz->delete_categories([$category, ...]);

# Access keywords
$biz               = $biz->add_keywords(\@kws)
($kw_list || @kws) = $biz->get_keywords()
($self || undef)   = $biz->has_keyword($keyword)
$biz               = $biz->delete_keywords([$kw, ...])

# Setting extra information
$id   = $biz->create_attr($sql_type, $length, $at_data_id, $data_param);
$data = $biz->get_attr()
$id   = $biz->create_map($map_class, $map_type, $data_param);

# Change control
$biz            = $biz->cancel()
$biz            = $biz->revert($version)
(undef || $biz) = $biz->checkin()
$biz            = $biz->checkout($param)


## INSTANCE METHODS FOR Bric::Biz::Asset::Business::Story

# Manipulation of slug field
$slug  = $story->get_slug()
$story = $story->set_slug($slug)

# Access the source ID
$src_id = $story->get_source__id()

# Change control
($story || undef) = $story->is_current()

# Ad string management
$story         = $story->delete_ad_param($key)
$ad_param_hash = $story->get_ad_param()
$story         = $story->set_ad_param($key ,$val);

# Publish data
$date  = $story->get_expire_date()
$story = $story->set_expire_date()

$date  = $story->get_publish_date()
$story = $story->set_publish_date()

# Save to the database
$story = $story->save()

DESCRIPTION

Story contains all of the data that will result in published page(s) It contains the metadata and associations with Formatting assets.

INTERFACE

Constructors

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

This will create a new story object with an optionaly defined intiial state

Supported Keys:

active
priority
title - same as name
name - Will be over ridden by title
description
workflow_id
slug
element__id - Required unless asset type object passed
element - the object required unless id is passed
source__id - required
cover_date - will set expire date in conjunction with the source

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

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

This will return a story asset that matches the id provided

Throws:

"Missing required parameter 'id'"

Side Effects:

NONE

Notes:

Inherited from Asset

(@stories||$stories) = Bric::Biz::Asset::Business::Story->list($params)

Returns a list or anonymous array of Bric::Biz::Asset::Business::Story objects based on the search parameters passed via an anonymous hash. The supported lookup keys are:

name - the same as the title field
title
description
id - the story id
version
slug
user__id - returns the versions that are checked out by the user, otherwise returns the most recent version
return_versions - returns past version objects as well
active - Will default to 1
inactive - Returns only inactive objects
category_id
keyword - a string (not an object)
workflow__id - workflow containing the story. Set to undef to return stories with no workflow.
primary_uri
category_uri
element__id
source__id
primary_oc_id
priority
publish_status - set to 1 to only return stories that have been published
publish_date_start - if end is left blank will return everything after the arg
publish_date_end - if start is left blank will return everything before the arg
cover_date_start - if end is left blank will return everything after the arg
cover_date_end - if start is left blank will return everything before the arg
expire_date_start - if end is left blank will return everything after the arg
expire_date_end - if start is left blank will return everything before the arg
Order - A property name to orer 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 number of objects specified by "Limit". Not used if "Limit" is not defined, and when "Limit" is defined and "Offset" is not, no objects will be skipped.
simple - a single OR search that hits title, description, primary_uri and keywords.

Throws:

Unable to connect to database.
Unable to prepare SQL statement.
Unable to select column into arrayref.
Unable to execute SQL statement.
Unable to bind to columns to statement handle.
Unable to fetch row from statement handle.

Side Effects:

NONE

Notes:

Inherited from Bric::Biz::Asset;

Destructors

$self->DESTROY: This is a dummy method to save autoload the time to find it

Public Class Methods

($ids || @ids) = Bric::Biz::Asset::Business::Story->list_ids( $criteria )

Returns an unordered list or array reference of story object IDs that match the criteria defined. The criteria are the same as those for the list() method except for Order and OrderDirection, which list_ids() ignore.

See the list() method for the list of supported Keys.

Throws: NONE.

Side Effects: NONE.

Notes: Inherited from Bric::Biz::Asset.

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

Returns the key name of this class.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

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

(@meths || $meths_aref) = Bric::Biz::Asset::Business::Story->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

$uri = $biz->get_uri(($cat_id||$cat_obj), ($oc_id||$oc_obj))

Returns the a URL for this business asset. The URL is determined by the pre- and post- directory strings of an 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:

No category associated with story.
Category not associated with story.
Output channel not associated with story.

Side Effects: NONE.

Notes: NONE.

$story = $story->set_slug($slug);

Sets the slug for this story

Throws:

'Invalid characters found in slug'

Side Effects:

NONE

Notes:

NONE

$slug = $story->get_slug()

returns the slug that has been set upon this story

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$story_name = $story->check_uri;

$story_name = $story->check_uri($user_id);

Returns name of story that has clashing URI.

($categories || @categories) = $ba->get_categories()

This will return a list of categories that have been associated with the business asset.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$cat = $story->get_primary_category()

Returns the category object that has been defined as primary

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$story = $story->set_primary_category($cat_id || $cat)

Defines a category as being the the primary one for this story. If a category is aready marked as being primary, this will disassociate it.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

(@cats || $cats) = $story->get_secondary_categories()

Returns the non-primary categories that are associated with this story

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$ba = $ba->add_categories( [ $category] )

This will take a list ref of category objects or ids and will associate them with the business asset

Side Effects:

Adds the asset_grp_ids of the categories to grp_ids (unless they are already there).

$ba = $ba->delete_categories([$category]);

This will take a list of categories and remove them from the asset

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$story = $story->checkout()

Preforms story specific checkout stuff and then calls checkout on the parent class

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

my (@gids || $gids_aref) = $story->get_grp_ids

my (@gids || $gids_aref) = Bric::Biz::Asset::Business::Story->get_grp_ids

Returns a list or anonymous array of Bric::Biz::Group object ids representing the groups of which this Bric::Biz::Asset::Business::Story object is a member.

Throws: See Bric::Util::Grp::list().

Side Effects: NONE.

Notes: This list includes the Group IDs of the Desk, Workflow, and categories in which the story is a member. [Actually, this method is currently disabled, since categories don't actually add assets to an underlying group. If we later find that customers need to control access to assets based on category, we'll figure out a way to rectify this.]

$story = $story->revert();

Reverts the current version to a prior version

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$story = $story->clone()

Creates an identical copy of this asset with a different id

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$story = $story->save()

Updates the story object in the database

Throws: NONE

Side Effects: NONE

Notes: NONE

PRIVATE

Private Class Methods

Private Instance Methods

$contribs = $self->_get_contributors()

Returns the contributors from a cache or looks em up

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$self = $self->_insert_contributor( $id, $role)

Inserts a row into the mapping table for contributors

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$self = $self->_update_contributor($id, $role)

Updates the contributor mapping table

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$self = $self->_delete_contributor($id)

Deletes the rows from these mapping tables

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$category_data = $self->_get_categories()

Returns the category data structure for this story

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$ba = $ba->_sync_categories

Called by save this will make sure that all the changes in category mappings are reflected in the database

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$ba = $ba->_insert_category($cat_id, $primary)

Adds a record that associates this ba with the category

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$ba = $ba->_delete_category( $cat_id)

Removes this record for the database

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$ba = $ba->_update_category($cat_id, $primary);

Preforms an update on the row in the data base

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$attribute_obj = $self->_get_attribute_object()

Returns the attribte object for this story

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$self = $self->_insert_story()

Inserts a story record into the database

Throws:

NONE

side Effects:

NONE

Notes:

NONE

$self = $self->_insert_instance()

Inserts an instance record into the database

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$self = $self->_update_story()

Updates the story record in the database

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$self = $self->_update_instance()

Updates the record for the story instance

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$self = $self->_delete_instance();

Deletes the version record from a cancled checkout

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$self = $self->_delete_story();

Deletes from the story table for a story that has never been checked in

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

NOTES

NONE

AUTHOR

Michael Soderstrom <miraso@pacbell.net>

NAME

VERSION

DATE

SYNOPSIS

DESCRIPTION

INTERFACE

Constructors

Destructors

Public Class Methods

Public Instance Methods

PRIVATE

Private Class Methods

Private Instance Methods

NOTES

AUTHOR

SEE ALSO