• 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

NAME

Bric::Biz::Asset::Business::Parts::Tile::Data - The tile class that contains the business data.

VERSION

$Revision: 1.12.4.3 $

DATE

$Date: 2004/03/16 19:19:21 $

SYNOPSIS

# Creation of New Objects
$tile = Bric::Biz::Asset::Business::Parts::Tile::Data->new($params);
$tile = Bric::Biz::Asset::Business::Parts::Tile::Data->lookup({ id => $id });
@tiles = Bric::Biz::Asset::Business::Parts::Tile::Data->list($params);

# Retrieval of Object IDs
@ids = = Bric::Biz::Asset::Business::Parts::Tile::Data->list_ids($params);

# Manipulation of Data Field
$tile = $tile->set_data( $data_asset );
$data_asset = $tile->get_data;

DESCRIPTION

This class holds the Business Asset Parts Data objects in a tile

INTERFACE

Constructors

$tile = Bric::Biz::Asset::Business::Parts::Tile::Data->new($init)

This will create a new tile object with the given state defined by the optional initial state argument

Supported Keys:

• active

• obj_type (story || media)

• obj_id

• place

• element_data_id

• parent_id

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$tile = Bric::Biz::Asset::Business::Parts::Tile::Data->lookup ({ id => $id})

This will return an existing tile object that is defined by the data tile ID.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

(@ts||$ts) = Bric::Biz::Assets::Business::Parts::Tile::Data->list($params)

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

Supported Keys:

• active

• obj

• obj_type

• obj_id

• ref_type

• ref_id

• place *

• element_data_id

• parent_id

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

Destructors

$self->DESTROY

a dummy method to save auto load some time

Public Class Methods

(@ids || $ids) = Bric::Biz::Assets::Business::Parts::Tile::Data->list_ids($p)

This will return a list or list ref of tile ids that match the given criteria

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

Public Instance Methods

$atd = $data->get_element_data_obj()

Returns the asset type data object associated with this data tile

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$name = $data->get_element_name()

Returns the name of the element

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$tile = $tile->set_data($value)

This will create the attribute on the business asset and store it in this tile.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$data = $tile->get_data

$data = $tile->get_data($format)

Returns the given business data from the tile. If the SQL type of the data object is "date", then $format will be used to format the date, if it is passed. Otherwise, the format set in the preferences will be used.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$self = $self->prepare_clone()

Business Data has to clone its self from time to time. Since tiles store the business data, this method prepares them to be cloned. It will set the id to undef and will be updated with new info come save time

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

undef = $tile->is_container()

Returns the fact that this is not a container tile

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

($self || $data) = $self->is_autopopulated()

Tells if this is an autopopulated tile

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$tile = $tile->lock_val()

For tiles that are autopopulated, this will prevent the value from being autopopulated.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$tile = $tile->unlock_val()

Unsets the lock val flag.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

($tile || undef) = $tile->is_locked();

Returns if the tile has been locked

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$tile = $tile->save()

Saves the chenges made to the database

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

PRIVATE

Private Class Methods

_do_list($class, $param, $ids)

Called by list or list_ids this returns either a list of ids or a list of objects, depending on the caller.

Throws:

• Object of type $obj_class not allowed to be tiled.

• Improper args for list.

Side Effects: NONE.

Notes: NONE.

Private Instance Methods

_do_insert()

inserts the row into the database

Throws:

• Object must be a media or story to add tiles.

Side Effects: NONE.

Notes: NONE.

$self = $self->_do_update()

Updates the row in the database.

Throws:

• Object must be a media or story to add tiles.

Side Effects: NONE.

Notes: NONE.

$at_obj = $self->_get_element_object()

Returns the asset type data object

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$attr_obj = $self->_get_sql_type()

Returns the sql type for this object.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$name = $self->_get_table_name()

$name = _get_table_name($object_type);

Returns the name of the table this object uses. This method can act as a class or instance method depending on how its called.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

NOTES

NONE

AUTHOR

Michael Soderstrom <miraso@pacbell.net>

SEE ALSO

perl, Bric, Bric::Biz::Asset, Bric::Biz::Asset::Business, Bric::Biz::Asset::Business::Parts::Tile