parameters: (self, snapshot_code, file_type='main', file_name='', mkdir=True, protocol='client_repo', ext='')
return_statement: return self.server.get_preallocated_path(self.ticket, snapshot_code, file_type, file_name, mkdir, protocol, ext)
docstring: API Function: get_preallocated_path(snapshot_code, file_type='main', file_name='', mkdir=True, protocol='client_repo', ext='')
          
          Get the preallocated path for this snapshot.  It assumes that
          this checkin actually exists in the repository and will create virtual
          entities to simulate a checkin.  This method can be used to determine
          where a checkin will go.  However, the snapshot must exist 
          using create_snapshot() or some other method.  For a pure virtual naming
          simulator, use get_virtual_snapshot_path().
  
          @param:
              snapshot_code - the code of a preallocated snapshot.  This can be
                  create by get_snapshot()
          
          @keyparam:
              file_type - the type of file that will be checked in.  Some naming
                  conventions make use of this information to separate directories
                  for different file types
              file_name - the desired file name of the preallocation.  This information
                  may be ignored by the naming convention or it may use this as a
                  base for the final file name
              mkdir - an option which determines whether the directory of the
                  preallocation should be created
              protocol - It's either client_repo, sandbox, or None. It determines whether the
                  path is from a client or server perspective
              ext - force the extension of the file name returned
  
          @return:
              string - the path where add_file() expects the file to be checked into
          @example:
  
          it saves time if you get the path and copy it to the final destination first. 
  
          [code]
          snapshot = self.server.create_snapshot(search_key, context)
          snapshot_code = snapshot.get('code')
          file_name = 'input_file_name.txt'
          orig_path = 'C:/input_file_name.txt'
          path = self.server.get_preallocated_path(snapshot_code, file_type, file_name)
  
          # the path where it is supposed to go is generated
          new_dir = os.path.dirname(path)
          if not os.path.exists(new_dir):
              os.makedirs(new_dir)
          shutil.copy(orig_path, path)
          self.server.add_file(snapshot_code, path, file_type, mode='preallocate')
          [/code]
docstring_summary: API Function: get_preallocated_path(snapshot_code, file_type='main', file_name='', mkdir=True, protocol='client_repo', ext='')
          
          Get the preallocated path for this snapshot.  It assumes that
          this checkin actually exists in the repository and will create virtual
          entities to simulate a checkin.  This method can be used to determine
          where a checkin will go.  However, the snapshot must exist 
          using create_snapshot() or some other method.  For a pure virtual naming
          simulator, use get_virtual_snapshot_path().
docstring_tokens: API Function : get_preallocated_path ( snapshot_code file_type = main file_name = mkdir = True protocol = client_repo ext = ) Get the preallocated path for this snapshot . It assumes that this checkin actually exists in the repository and will create virtual entities to simulate a checkin . This method can be used to determine where a checkin will go . However the snapshot must exist using create_snapshot () or some other method . For a pure virtual naming simulator use get_virtual_snapshot_path () .
function: def get_preallocated_path(self, snapshot_code, file_type='main', file_name='', mkdir=True, protocol='client_repo', ext=''):
          '''API Function: get_preallocated_path(snapshot_code, file_type='main', file_name='', mkdir=True, protocol='client_repo', ext='')
          
          Get the preallocated path for this snapshot.  It assumes that
          this checkin actually exists in the repository and will create virtual
          entities to simulate a checkin.  This method can be used to determine
          where a checkin will go.  However, the snapshot must exist 
          using create_snapshot() or some other method.  For a pure virtual naming
          simulator, use get_virtual_snapshot_path().
  
          @param:
              snapshot_code - the code of a preallocated snapshot.  This can be
                  create by get_snapshot()
          
          @keyparam:
              file_type - the type of file that will be checked in.  Some naming
                  conventions make use of this information to separate directories
                  for different file types
              file_name - the desired file name of the preallocation.  This information
                  may be ignored by the naming convention or it may use this as a
                  base for the final file name
              mkdir - an option which determines whether the directory of the
                  preallocation should be created
              protocol - It's either client_repo, sandbox, or None. It determines whether the
                  path is from a client or server perspective
              ext - force the extension of the file name returned
  
          @return:
              string - the path where add_file() expects the file to be checked into
          @example:
  
          it saves time if you get the path and copy it to the final destination first. 
  
          [code]
          snapshot = self.server.create_snapshot(search_key, context)
          snapshot_code = snapshot.get('code')
          file_name = 'input_file_name.txt'
          orig_path = 'C:/input_file_name.txt'
          path = self.server.get_preallocated_path(snapshot_code, file_type, file_name)
  
          # the path where it is supposed to go is generated
          new_dir = os.path.dirname(path)
          if not os.path.exists(new_dir):
              os.makedirs(new_dir)
          shutil.copy(orig_path, path)
          self.server.add_file(snapshot_code, path, file_type, mode='preallocate')
          [/code]
             
          '''
          return self.server.get_preallocated_path(self.ticket, snapshot_code, file_type, file_name, mkdir, protocol, ext)
function_tokens: def get_preallocated_path ( self , snapshot_code , file_type = 'main' , file_name = '' , mkdir = True , protocol = 'client_repo' , ext = '' ) : return self . server . get_preallocated_path ( self . ticket , snapshot_code , file_type , file_name , mkdir , protocol , ext )