:: com :: sun :: star :: frame ::

interface XStorable

Methods' Summary
hasLocation The object may know the location because it was loaded from there, or because it is stored there.  
getLocation After XStorable::storeAsURL() it returns the URL the object was stored to.  
isReadonly It is not possible to call XStorable::store() successfully when the data store is read-only.  
store stores the data to the URL from which it was loaded.  
storeAsURL stores the object's persistent data to a URL and makes this URL the new location of the object.  
storeToURL stores the object's persistent data to a URL and continues to be a representation of the old URL.  
Methods' Details
hasLocation
boolean
hasLocation();

Description
The object may know the location because it was loaded from there, or because it is stored there.
Returns
`TRUE` if the object knows a location where it is persistent `FALSE` otherwise
getLocation
string
getLocation();

Description
After XStorable::storeAsURL() it returns the URL the object was stored to.
Returns
the URL of the resource which is represented by this object.
isReadonly
boolean
isReadonly();

Description
It is not possible to call XStorable::store() successfully when the data store is read-only.
Returns
`TRUE` if the data store is readonly or opened readonly `FALSE` otherwise
store
void
store()
raises( ::com::sun::star::io::IOException );

Description
stores the data to the URL from which it was loaded.

Only objects which know their locations can be stored.

Throws
com::sun::star::io::IOException if an IO error occurred during save operation (may the location is unknown)
See also
XStorable::storeAsURL, XStorable::storeToURL
storeAsURL
void
storeAsURL( [in] string  sURL,
[in] sequence< ::com::sun::star::beans::PropertyValue >  lArguments )
raises( ::com::sun::star::io::IOException );

Description
stores the object's persistent data to a URL and makes this URL the new location of the object.

This is the normal behavior for UI's "save-as" feature.

The change of the location makes it necessary to store the document in a format that the object can load. For this reason the implementation of XStorable::storeAsURL() will throw an exception if a pure export filter is used, it will accept only combined import/export filters. For such filters the method XStorable::storeToURL() must be used that does not change the location of the object.

Parameter sURL
specifies the new location of this component
Parameter lArguments
optional parameters for saving (see com::sun::star::document::MediaDescriptor for further details)
Throws
com::sun::star::io::IOException if an IO error occurred during save operation (may the location is unknown)
See also
XStorable::store, XStorable::storeToURL, ::com::sun::star::document::MediaDescriptor
storeToURL
void
storeToURL( [in] string  sURL,
[in] sequence< ::com::sun::star::beans::PropertyValue >  lArguments )
raises( ::com::sun::star::io::IOException );

Description
stores the object's persistent data to a URL and continues to be a representation of the old URL.

This is the normal behavior for UI's export feature.

This method accepts all kinds of export filters, not only combined import/export filters because it implements an exporting capability, not a persistence capability.

Throws
com::sun::star::io::IOException if an IO error occurred during save operation (may the location is unknown)
Parameter sURL
specifies the location where to store the object
Parameter lArguments
optional parameters for saving (see com::sun::star::document::MediaDescriptor for further details)
See also
XStorable::store, XStorable::storeAsURL, ::com::sun::star::document::MediaDescriptor
Top of Page