|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DataSource
This interface defines methods for DataSource.
Nested Class Summary | |
---|---|
static class |
DataSource.Property
Datasource Property type |
static class |
DataSource.Type
Datasource type |
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
delete()
Deletes the Datasource |
java.lang.String |
getName()
Returns the name of this datasource |
java.lang.String |
getProperty(DataSource.Property propertyName)
Retrieves the properties of this datasource |
DataSource.Type |
getType()
Retrieves the datasource type |
void |
save()
Saves the changes made to this datasource |
void |
setProperty(DataSource.Property propertyName,
java.lang.String propertyValue)
Sets the datasource property |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
java.lang.String getName()
PIMInternalException
- If there is an internal errorDataSource.Type getType()
PIMInternalException
- If an internal error occursjava.lang.String getProperty(DataSource.Property propertyName)
propertyName
- The name of the property
PIMInternalException
- If an internal error occurs
java.lang.UnsupportedOperationException
- If the user tries to get a property which is not valid for
this type of DataSource
java.lang.IllegalArgumentException
- If propertyName passed in is nullvoid setProperty(DataSource.Property propertyName, java.lang.String propertyValue)
propertyName
- The name of the property to be setpropertyValue
- The value for the property
PIMInternalException
- If an internal error occurs
java.lang.UnsupportedOperationException
- If the user tries to set a property which is not valid for
this type of DataSource
java.lang.IllegalArgumentException
- If the argument passed in are null or emptyvoid delete()
PIMInternalException
- If an internal error occurs while performing this operation
PIMAuthorizationException
- Reserved for future usevoid save()
PIMInternalException
- If an internal error occurs while performing this operation
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalStateException
- If the state of the Datasource Properties are not set
properly when attempting a save
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |