org.sakaiproject.api.kernel.tool
Interface Placement

All Known Subinterfaces:
ToolConfiguration
All Known Implementing Classes:
BaseToolConfiguration, Placement

public interface Placement

Tool Placement models a particular tool places in a particular place within a Sakai navigation or portal location.

Version:
$Revision: 632 $
Author:
University of Michigan, Sakai Software Development Team

Method Summary
 Properties getConfig()
          Access the configuration properties, combined from placement and registration, for the tool placement.
 String getContext()
          Access the placement context.
 String getId()
          Get the tool placement id.
 Properties getPlacementConfig()
          Access the configuration properties for this tool placement - not including those from the tool registration.
 String getTitle()
          Access the tool placement title.
 Tool getTool()
          Access the tool placeed with this placement.
 void save()
          Save any changes to the placement.
 void setTitle(String title)
          Set the title for this tool placement.
 void setTool(Tool tool)
          Set the tool for this tool placement.
 

Method Detail

getConfig

public Properties getConfig()
Access the configuration properties, combined from placement and registration, for the tool placement. Placement values override registration. Access is read only.

Returns:
The read-only combined configuration properties for the tool.

getContext

public String getContext()
Access the placement context.

Returns:
The context associated with this tool placement.

getId

public String getId()
Get the tool placement id.

Returns:
The tool placement id.

getPlacementConfig

public Properties getPlacementConfig()
Access the configuration properties for this tool placement - not including those from the tool registration.

Returns:
The configuration properties for this tool placement - not including those from the tool registration.

getTitle

public String getTitle()
Access the tool placement title.

Returns:
The tool placement title.

getTool

public Tool getTool()
Access the tool placeed with this placement.

Returns:
The tool placed with this placement.

setTitle

public void setTitle(String title)
Set the title for this tool placement. Non-null values override the tool registration title.

Parameters:
title - The tool placement title.

setTool

public void setTool(Tool tool)
Set the tool for this tool placement.

Parameters:
tool - The tool.

save

public void save()
Save any changes to the placement.