001: /**
002: * $Id: ProviderProvisionProperties.java,v 1.2 2005/04/20 20:49:31 mjain Exp $
003: * Copyright 2005 Sun Microsystems, Inc. All
004: * rights reserved. Use of this product is subject
005: * to license terms. Federal Acquisitions:
006: * Commercial Software -- Government Users
007: * Subject to Standard License Terms and
008: * Conditions.
009: *
010: * Sun, Sun Microsystems, the Sun logo, and Sun ONE
011: * are trademarks or registered trademarks of Sun Microsystems,
012: * Inc. in the United States and other countries.
013: */package com.sun.portal.providers.service.provision;
014:
015: import java.util.Set;
016:
017: import java.io.File;
018:
019: import java.util.Map;
020: import java.util.List;
021: import java.util.ArrayList;
022: import java.util.Vector;
023: import java.util.Hashtable;
024:
025: /**
026: * ProviderProvisionPreferences is an interface that can be used
027: * by the developer to set and get properties
028: * for a provider instance. It shows the same properties that
029: * can be set through amconsole or taskadmin on a provider channel.
030: * @author mjain
031: */
032: public interface ProviderProvisionProperties {
033: /**
034: * This method sets the value for the given
035: * string property.
036: * @param key property name
037: * @value
038: * @param pflist
039: * @return
040: * @throws ProvisionPreferencesException
041: */
042: public void setStringProperty(String key, String value, List pflist)
043: throws ProviderProvisionPropertiesException;
044:
045: /**
046: * This method sets the List value object for the given
047: * List property.
048: * @param key property name
049: * @value
050: * @param pflist
051: * @return
052: * @throws ProvisionPreferencesException
053: */
054: public void setListProperty(String key, List value, List pflist)
055: throws ProviderProvisionPropertiesException;
056:
057: /**
058: * This method sets the Map collection object for the given
059: * collection property.
060: * @param key property name
061: * @value
062: * @param pflist
063: * @return
064: * @throws ProvisionPreferencesException
065: */
066: public void setMapProperty(String key, Map value, List pflist)
067: throws ProviderProvisionPropertiesException;
068:
069: /**
070: * This method sets the integer object for the given
071: * integer property.
072: * @param key property name
073: * @value
074: * @param pflist
075: * @return
076: * @throws ProvisionPreferencesException
077: */
078: public void setIntegerProperty(String key, int value, List pflist)
079: throws ProviderProvisionPropertiesException;
080:
081: /**
082: * This method sets the value for the given
083: * boolean property.
084: * @param key property name
085: * @value
086: * @param pflist
087: * @return
088: * @throws ProvisionPreferencesException
089: */
090: public void setBooleanProperty(String key, boolean value,
091: List pflist) throws ProviderProvisionPropertiesException;
092:
093: /**
094: * Return the value for channel String property.
095: * @param key property name
096: * @param pflist properties filter list
097: * @return Value of the string property.
098: * @throws ProvisionPreferencesException
099: */
100: public String getStringProperty(String key, List pflist)
101: throws ProviderProvisionPropertiesException;
102:
103: /**
104: * Return the value for channel integer property.
105: * @param key property name
106: * @param pflist properties filter list
107: * @return value of the integer property.
108: * @throws ProvisionPreferencesException
109: */
110: public int getIntegerProperty(String key, List pflist)
111: throws ProviderProvisionPropertiesException;
112:
113: /**
114: * Return the value for channel's boolean property.
115: * @param key property name
116: * @param pflist properties filter list
117: * @return value of the boolean property.
118: * @throws ProvisionPreferencesException
119: */
120: public boolean getBooleanProperty(String key, List pflist)
121: throws ProviderProvisionPropertiesException;
122:
123: /**
124: * This method returns the Map collection object for the given
125: * collection property.
126: * @param key property name
127: * @param pflist
128: * @return
129: * @throws ProvisionPreferencesException
130: */
131: public Map getMapProperty(String key, List pflist)
132: throws ProviderProvisionPropertiesException;
133:
134: /**
135: * This method returns the List collection object for the given
136: * collection property.
137: * @param key property name
138: * @param pflist
139: * @return
140: * @throws ProvisionPreferencesException
141: */
142: public List getListProperty(String key, List pflist)
143: throws ProviderProvisionPropertiesException;
144:
145: /**
146: * This method returns the list of property names that are existing
147: * for the given channel name. This method
148: * returns only the default property names and filters out all the conditional
149: * properties.
150: *
151: * @param advanced advanced flag to specify whether to return basic/advanced propertynames.
152: * @return Set Contaning property name list.
153: */
154: public Set getPropertyNames(boolean advanced)
155: throws ProviderProvisionPropertiesException;
156:
157: }
|