• NAME
• VERSION
• DATE
• SYNOPSIS
• DESCRIPTION
• INTERFACE
  • Constructors
  • Destructors
  • Public Class Methods
  • Public Instance Methods
• PRIVATE
  • Private Class Methods
  • Private Instance Methods
  • Private Functions
• NOTES
• AUTHOR
• SEE ALSO
• POD ERRORS

NAME

Bric::Biz::Workflow::Parts::Desk;

Impliments a desk object as part of a workflow

VERSION

$Revision: 1.3.2.2 $

DATE

$Date: 2001/11/06 23:18:34 $

SYNOPSIS

use Bric::Biz::Workflow::Parts::Desk;

my $desk = new Bric::Biz::Workflow::Parts::Desk($init);

my $desk = lookup Bric::Biz::Workflow::Parts::Desk($param);

my @dsks = list Bric::Biz::Workflow::Parts::Desk($param);

my $name = $desk->get_name;
my $desk = $desk->set_name($name);

my $dscr = $desk->get_description;
my $desk = $desk->set_description($dscr);

$desk    = $desk->link_desk($param)

$desk    = $desk->unlink_desk({});

$desk    = $desk->add_rule({'rule_pkg'  => $pkg,
                            'rule_name' => $name})

$desk    = $desk->del_rule({'rule_pkg'  => $pkg, 'rule_name' => $name});

# Return a list of assets on this desk.
@assets  = $desk->assets();

# Transfer a asset to a different desk.
$ret     = $desk->transfer($asset_obj, $another_desk);

# Accept a asset from another desk.
$ret     = $desk->accept($asset_obj);

$desk    = $desk->save;

DESCRIPTION

A desk is something that defines the steps in a workflow. Assets arrive at a desk and remain there until they are approved and moved to the next desk in the workflow.

A desk may have any number of assets associated with it at any time. Users may checkout copies of these assets from the desk, make changes to them and check them back into the desk. Users may also get read only copies.

INTERFACE

Constructors

$success = $obj = new Bric::Biz::Workflow::Parts::Desk($init);

The following is a list of parameter keys and their assiociated values.

Keys for $init are:

• name

  The name of this desk

• description

  A description of this desk

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$success = $obj = lookup Bric::Biz::Workflow::Parts::Desk($param);

Look up a desk object by ID. Keys for param are:

• id

  A desk ID

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

@objs = Bric::Biz::Workflow::Parts::Desk->list($param);

Returns a list of desk objects based on $param. Keys of $param are:

name

Return all desks matching a certain name

description

Return all desks with a matching description.

active

Boolean; Return all in/active workflows

All searches except 'active' are done using the LIKE operator, so '%' can be used for substring searching.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

@objs = Bric::Biz::Workflow::Parts::Desk->list($param);

Returns a list of IDs for all desk objects. See 'list' for legal parameters.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

Destructors

$self->DESTROY

Dummy method to prevent wasting time trying to AUTOLOAD DESTROY.

Public Class Methods

NONE

my $meths = Bric::Biz::Workflow::Parts::Desk->my_meths

my (@meths || $meths_aref) = Bric::Biz::Workflow::Parts::Desk->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

@assets = $desk->assets();

Return a list of assets on this desk.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$ret = $desk->checkin($asset_obj);

$ret = $desk->checkout($asset_obj, $user_id);

Checkin/checkout an asset from this desk.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$ret = $desk->transfer($param);

Transfer a asset to a different desk. Keys for $param are:

• asset

  An asset object.

• to

  The desk to which this asset should be transfered.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$ret = $desk->accept($param);

Accept a asset from another desk. Keys for $param are:

• from

  The desk from which this asset is comming. Can be omitted if this is the first desk in the workflow.

• asset

  The asset to accept.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$ret = $desk->remove_asset();

Remove an asset from this desk.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$assets = $desk->get_assets;

Return a list of assets on this desk.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$assets_href = $desk->get_assets_href;

Return an anonymous hash of assets on this desk. The keys are the key names of the class of each asset, and the values are anonymous arrays of the assets of that type.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$att || undef = $desk->can_publish

$att = $desk->make_publish_desk;

$att = $desk->make_regular_desk;

Get/Set is-publish-desk flag.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$att || undef = $desk->is_active;

$att = $desk->activate;

$att = $desk->deactivate;

Get/Set the active flag.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$desk->remove;

Get/Set the active flag.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$desk = $desk->save;

Checks the user to see if s/he has the right priviledges to checkout stories.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

PRIVATE

Private Class Methods

NONE

Private Instance Methods

$obj = $desk->_get_grp_obj($id_field, $obj_field)

Retrieve the group object if its set in this object. Otherwise, try to look it up via the ID field passed.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$desk = $desk->_select_desk

Select values from the desk table.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$desk = $desk->_insert_desk

Insert values into the Desk table from the desk structure.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$desk = $desk->_update_desk

Update values from the desk structure.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$desk = $desk->_remove_desk

Remove this desk.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

Private Functions

NONE

NOTES

NONE

AUTHOR

"Garth Webb" <garth@perijove.com>
Creative Engines Engineering

SEE ALSO

Bric, Bric::Biz::Workflow, perl

POD ERRORS

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

Around line 291:

Unknown directive: =init

Around line 297:

Unknown directive: =init

Around line 303:

Unknown directive: =init

Around line 407:

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

Around line 409:

'=item' outside of any '=over'

Around line 422:

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

Around line 430:

'=item' outside of any '=over'

Around line 512:

Expected '=item *'

Around line 514:

Expected '=item *'

Around line 516:

Expected '=item *'

Around line 518:

Expected '=item *'

Around line 520:

Expected '=item *'

Around line 522:

Expected '=item *'

Around line 524:

Expected '=item *'

Around line 633:

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

Around line 639:

'=item' outside of any '=over'

Around line 1146:

You forgot a '=back' before '=head1'

Around line 1193:

'=item' outside of any '=over'

Around line 1383:

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

Around line 1396:

=back without =over