Update of /cvsroot/sandweb/sandweb/doc/API
In directory usw-pr-cvs1:/tmp/cvs-serv22967
Added Files:
File.txt
Log Message:
added documentation for File object
--- NEW FILE ---
SandWeb::File
--------------------------------------------------------------------------------
METHOD
new
SYNOPSIS
my $file = SandWeb::File->new(
location => $location;
filename => $filename;
);
DESCRIPTION
This method is a constructor. It needs to know the location of the
file as well as the name of the file.
PARAMETERS
location (type: string) (required)
This contains the full ( absolute or relative ) path
to the file, as far as the file system is concerned.
Default: none.
filename (type: string) (required)
This contains the path to the filename from the
user's sandbox ( including the filename itself ).
Default: none.
RETURN CODES
1 = The operation completed successfully.
0 = This means that the method got an error proccessing your request.
Perhaps an invalid parameter?
-1 = This return value means that there was not sufficient permision to
read the files specified, or they did not exist.
--------------------------------------------------------------------------------
METHOD
get_owner
SYNOPSIS
my $owner = $file->get_owner();
DESCRIPTION
Returns the UID of the owner of the file.
PARAMETERS
None.
RETURN CODES
1 = The operation completed successfully.
0 = This means that the method got an error proccessing your request.
Perhaps an invalid parameter?
-1 = This return value means that there was not sufficient permision to
read the files specified, or they did not exist.
--------------------------------------------------------------------------------
METHOD
get_group
SYNOPSIS
my $group = $file->get_group();
DESCRIPTION
Returns the GID of the group membership of the file.
PARAMETERS
None.
RETURN CODES
1 = The operation completed successfully.
0 = This means that the method got an error proccessing your request.
Perhaps an invalid parameter?
-1 = This return value means that there was not sufficient permision to
read the files specified, or they did not exist.
--------------------------------------------------------------------------------
METHOD
get_filename
SYNOPSIS
my $filename = $file->get_filename();
DESCRIPTION
Returns the path from the user's sandbox and
the full name of the file.
PARAMETERS
None.
RETURN CODES
1 = The operation completed successfully.
0 = This means that the method got an error proccessing your request.
Perhaps an invalid parameter?
-1 = This return value means that there was not sufficient permision to
read the files specified, or they did not exist.
--------------------------------------------------------------------------------
METHOD
get_location
SYNOPSIS
my $location = $file->get_location();
DESCRIPTION
Returns the full ( absolute or relative ) path
to the user's sandbox, as far as the file system
is concerned.
PARAMETERS
None.
RETURN CODES
1 = The operation completed successfully.
0 = This means that the method got an error proccessing your request.
Perhaps an invalid parameter?
-1 = This return value means that there was not sufficient permision to
read the files specified, or they did not exist.
--------------------------------------------------------------------------------
METHOD
get_permissions
SYNOPSIS
my $permissions = $file->get_permissions();
DESCRIPTION
Returns the current file system permissions,
as an octal value.
PARAMETERS
None.
RETURN CODES
1 = The operation completed successfully.
0 = This means that the method got an error proccessing your request.
Perhaps an invalid parameter?
-1 = This return value means that there was not sufficient permision to
read the files specified, or they did not exist.
--------------------------------------------------------------------------------
METHOD
get_file_type
SYNOPSIS
my $file_type = $file->get_file_type();
DESCRIPTION
Returns Perl's guess as to what type of file
this is. Type returned one of : Binary, Text,
Directory or Unknown.
PARAMETERS
None.
RETURN CODES
1 = The operation completed successfully.
0 = This means that the method got an error proccessing your request.
Perhaps an invalid parameter?
-1 = This return value means that there was not sufficient permision to
read the files specified, or they did not exist.
|
