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

NAME

Bric::Biz::OutputChannel - The manner of keeping track of output channels

VERSION

$Revision: 1.5.2.4 $

DATE

$Date: 2001/11/15 02:56:43 $

SYNOPSIS

$oc = Bric::Biz::OutputChannel->new( $initial_state )

$oc = Bric::Biz::OutputChannel->lookup( { id => $id} )

($ocs_aref || @ocs) = Bric::Biz::OutputChannel->list( $criteria )

($id_aref || @ids) = Bric::Biz::OutputChannel->list_ids( $criteria )

$oc = $oc->set_name( $name )

$name = $oc->get_name()

$oc = $oc->set_description( $description )

$description = $oc->get_description()

$oc = $oc->set_tile_aware( undef || 1)

(undef || 1 ) = $oc->get_tile_aware()

$oc = $oc->set_primary( undef || 1)

(undef || 1 ) = $oc->get_primary()

$oc = $oc->activate()

$oc = $oc->deactivate()

$oc = $oc->is_active()

$id = $oc->get_id()

$oc = $oc->save()

DESCRIPTION

Holds information about the output channels that will be associated with templates and elements

INTERFACE

Public Methods

$oc = Bric::Biz::Output_channel->new( $initial_state )

This will create a new Output channel object with the optional defined state

suported keys:

• name

• description

• tile_aware

• primary

• active (default is active, pass undef to make a new inactive Output Channe;

Throws: NONE

Side Effects: NONE

Notes: NONE

$oc = Bric::Biz::Output_channel->lookup( { id => $id} )

Will look up an output channel object for a given id

Throws: NONE

Side Effects: NONE

Notes: NONE

($ocs_aref || @ocs) = Bric::Biz::Output_channel->list( $criteria )

Will return a list of objects that match a given criteria

supported keys:

• name

• primary

• tile_aware

• server_type_id

• active

Throws: NONE

Side Effects: NONE

Notes: NONE

$ocs_href = Bric::Biz::OutputChannel->href( $criteria )

Returns an anonymous hash of Output Channel objects, where each hash key is an Output Channel ID, and each value is Output Channel object that corresponds to that ID. Takes the same arguments as list().

Throws: NONE

Side Effects: NONE

Notes: NONE

Destructors

$self->DESTROY

Dummy method to prevent wasting time trying to AUTOLOAD DESTROY.

Public Class Methods

($id_aref || @ids) = Bric::Biz::Output_channel->list_ids( $criteria )

Will return a list of ids that match the given criteria

Supported Keys:

name

primary

tile_aware

Throws: NONE

Side Effects: NONE

Notes: NONE

$meths = Bric::Biz::AssetType->my_meths

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

$oc = $oc->set_name( $name )

Sets the name field

Throws: NONE

Side Effects: NONE

Notes: NONE

$name = $oc->get_name()

Returns the name field

Throws: NONE

Side Effects: NONE

Notes: NONE

$oc = $oc->set_description( $description )

Sets the description Field

Throws: NONE

Side Effects: NONE

Notes: NONE

$description = $oc->get_description()

Returns the description field

Throws: NONE

Side Effects: NONE

Notes: NONE

$oc = $oc->set_pre_path($pre_path)

Sets the string that will be used at the beginning of the URIs for assets in this Output Channel.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$pre_path = $oc->get_pre_path

Gets the string that will be used at the beginning of the URIs for assets in this Output Channel.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$oc = $oc->set_post_path($post_path)

Sets the string that will be used at the end of the URIs for assets in this Output Channel.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$post_path = $oc->get_post_path

Gets the string that will be used at the end of the URIs for assets in this Output Channel.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$oc = $oc->set_filename($filename)

Sets the filename that will be used in the names of files burned into this Output Channel.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$filename = $oc->get_filename

Gets the filename that will be used in the names of files burned into this Output Channel. Defaults to the value of the DEFAULT_FILENAME configuration directive if unset.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$oc = $oc->set_file_ext($file_ext)

Sets the filename extension that will be used in the names of files burned into this Output Channel.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$file_ext = $oc->get_file_ext

Gets the filename extension that will be used in the names of files burned into this Output Channel. Defaults to the value of the DEFAULT_FILE_EXT configuration directive if unset.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$oc = $oc->set_tile_aware( undef || 1)

Set the flag for wheather this output channel is tile aware

Throws: NONE

Side Effects: NONE

Notes: NONE

(undef || 1 ) = $oc->get_tile_aware()

Return if this channel is tile aware or not

Throws: NONE

Side Effects: NONE

Notes: NONE

$oc = $oc->set_primary( undef || 1)

Set the flag that this is the primary out put channel or not

Throws: NONE

Side Effects: NONE

Notes: NONE

(undef || 1 ) = $oc->get_primary()

Returns 1 if this is the primary output channel undef otherwise

Throws: NONE

Side Effects: NONE

Notes: Only one Output channel can be the primary output channel

$oc = $oc->activate()

MAkes the item active

Throws: NONE

Side Effects: NONE

Notes: NONE

$oc = $oc->deactivate()

Makes the item inactive

Throws: NONE

Side Effects: NONE

Notes: NONE

(undef || 1) = $oc->is_active()

Returns if the Output channel is active or not

Throws: NONE

Side Effects: NONE

Notes: NONE

$id = $oc->get_id()

Returns the data base id of the object

Throws: NONE

Side Effects: NONE

Notes: NONE

$oc = $oc->save()

Saves the info to the database

Throws: NONE

Side Effects: NONE

Notes: NONE

PRIVATE

Private Class Methods

_do_list

called by list and list ids this does the brunt of their work

Throws: NONE

Side Effects: NONE

Notes: NONE

Private Instance Methods

_do_update()

will perform the update to the data base after being called from save

Throws: NONE

Side Effects: NONE

Notes: NONE

_do_insert

Will do the insert to the database after being called by save

Throws: NONE

Side Effects: NONE

Notes: NONE

NOTES

NONE

AUTHOR

michael soderstrom ( miraso@pacbell.net )

SEE ALSO

perl,Bric,Bric::Biz::Asset::Business,Bric::Biz::element,
Bric::Biz::Asset::Formatting 

POD ERRORS

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

Around line 348:

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

Around line 350:

'=item' outside of any '=over'

Around line 363:

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

Around line 368:

'=item' outside of any '=over'

Around line 484:

Expected '=item *'

Around line 486:

Expected '=item *'

Around line 488:

Expected '=item *'

Around line 490:

Expected '=item *'

Around line 492:

Expected '=item *'

Around line 494:

Expected '=item *'

Around line 496:

Expected '=item *'

Around line 651:

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

Around line 656:

'=item' outside of any '=over'

Around line 970:

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

Around line 978:

'=item' outside of any '=over'

Around line 1083:

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

Around line 1085:

'=item' outside of any '=over'

Around line 1150:

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